NSBLOBAgent - SuperOffice

Collection of all services that work with binary objects (BLOBS). For example, images and documents.

Constructors

NSBLOBAgent()

NSBLOBAgent

Initializes a new instance of the NSBLOBAgent class.

Methods

ChangeContactImage(Integer,Integer)

Changes the contact image link.

Void ChangeContactImage(Integer contactId, Integer blobId)

Returns: CRMScript.Global.Void

If the Binary object ID is 0, any image link is removed from the contact.

ChangePersonImage(Integer,Integer)

Void ChangePersonImage(Integer personId, Integer blobId)

Returns: CRMScript.Global.Void

If the Binary object ID is 0, any image link is removed from the person.

ChangeProductImage(Integer,Integer)

Changes the project image link.

Void ChangeProductImage(Integer productId, Integer blobId)

Returns: CRMScript.Global.Void

If the Binary object ID is 0, any image link is removed from the project.

ChangeProjectImage(Integer,Integer)

Changes the project image link.

Void ChangeProjectImage(Integer projectId, Integer blobId)

Returns: CRMScript.Global.Void

If the Binary object ID is 0, any image link is removed from the project.

CleanupBatchTask(Integer)

Removes the binary objects linked to the batch task, the links themselves and the batch task.

Void CleanupBatchTask(Integer batchTaskId)

Returns: CRMScript.Global.Void

CreateDefaultBlobEntity()

Sets default values into a new NSBlobEntity.

NSBlobEntity CreateDefaultBlobEntity()

Returns: CRMScript.NetServer.NSBlobEntity - New BlobEntity with default values.

NetServer calculates default values (for example Country) on the entity, which is required when creating/storing a new instance.

Example:

NSBLOBAgent agent;
NSBlobEntity thing = agent.CreateDefaultBlobEntity();
thing = agent.SaveBlobEntity(thing);

DeleteBlobEntity(Integer)

Deletes the NSBlobEntity

Void DeleteBlobEntity(Integer blobEntity)

Returns: CRMScript.Global.Void Example:

NSBLOBAgent agent;
agent.DeleteBlobEntity(123);

GetAppData(String)

Gets a CLOB (limited to a reasonable size by the mechanics of Web Services) according to a string key; ALSO limits to the current ApplicationToken if any

String GetAppData(String key)

Returns: CRMScript.Global.String - The applications value, suggested to be a JSON, XML or other readable structure. Example:

NSBLOBAgent agent;
String key;
String res = agent.GetAppData(key);

GetBlobEntity(Integer)

Gets an NSBlobEntity object.

NSBlobEntity GetBlobEntity(Integer blobEntityId)

Returns: CRMScript.NetServer.NSBlobEntity - BlobEntity object. Example:

NSBLOBAgent agent;
NSBlobEntity thing = agent.GetBlobEntity(123);

GetBlobEntityOnContact(Integer)

Gets the blob entity that represents the contact image binary object.

NSBlobEntity GetBlobEntityOnContact(Integer contactId)

Returns: CRMScript.NetServer.NSBlobEntity - BlobEntity object. Example:

NSBLOBAgent agent;
Integer contactId;
NSBlobEntity res = agent.GetBlobEntityOnContact(contactId);

GetBlobEntityOnCountry(Integer)

Gets the blob entity that represents the country flag binary object.

NSBlobEntity GetBlobEntityOnCountry(Integer countryId)

Returns: CRMScript.NetServer.NSBlobEntity - BlobEntity object. Example:

NSBLOBAgent agent;
Integer countryId;
NSBlobEntity res = agent.GetBlobEntityOnCountry(countryId);

GetBlobEntityOnPerson(Integer)

Gets the blob entity that represents the person image binary object.

NSBlobEntity GetBlobEntityOnPerson(Integer personId)

Returns: CRMScript.NetServer.NSBlobEntity - BlobEntity object. Example:

NSBLOBAgent agent;
Integer personId;
NSBlobEntity res = agent.GetBlobEntityOnPerson(personId);

GetBlobEntityOnProduct(Integer)

Gets the blob entity that represents the product image binary object.

NSBlobEntity GetBlobEntityOnProduct(Integer productId)

Returns: CRMScript.NetServer.NSBlobEntity - BlobEntity object. Example:

NSBLOBAgent agent;
Integer productId;
NSBlobEntity res = agent.GetBlobEntityOnProduct(productId);

GetBlobEntityOnProject(Integer)

Gets the blob entity that represents the project image binary object.

NSBlobEntity GetBlobEntityOnProject(Integer projectId)

Returns: CRMScript.NetServer.NSBlobEntity - BlobEntity object. Example:

NSBLOBAgent agent;
Integer projectId;
NSBlobEntity res = agent.GetBlobEntityOnProject(projectId);

GetBlobStream(Integer)

Gets the binary object as a stream

NSStream GetBlobStream(Integer blobEntityId)

Returns: CRMScript.NetServer.NSStream - The binary object as a Stream. Example:

NSBLOBAgent agent;
Integer blobEntityId;
NSStream res = agent.GetBlobStream(blobEntityId);

GetChatImageWithSize(Integer,Integer,Integer)

Returns the chat image that is displayed in chat with a specified maximum size.

NSImage GetChatImageWithSize(Integer chatTopicId, Integer width, Integer height)

Returns: CRMScript.NetServer.NSImage - The image as a System.Drawing.Image. (If the the image is returned over web services, the stream is returned as a jpeg/base64 encoded string.). Example:

NSBLOBAgent agent;
Integer chatTopicId;
Integer width;
Integer height;
NSImage res = agent.GetChatImageWithSize(chatTopicId, width, height);

GetContactImage(Integer)

Returns the contact image that is displayed in the CRM application.

NSImage GetContactImage(Integer contactId)

Returns: CRMScript.NetServer.NSImage - The image as a System.Drawing.Image. (If the the image is returned over web services, the stream is returned as a Base64 encoded string.). Example:

NSBLOBAgent agent;
Integer contactId;
NSImage res = agent.GetContactImage(contactId);

GetContactImageWithSize(Integer,Integer,Integer)

Returns the contact image that is displayed in the CRM application with a specified maximum size.

NSImage GetContactImageWithSize(Integer contactId, Integer width, Integer height)

Returns: CRMScript.NetServer.NSImage - The image as a System.Drawing.Image. (If the the image is returned over web services, the stream is returned as a Base64 encoded string.). Example:

NSBLOBAgent agent;
Integer contactId;
Integer width;
Integer height;
NSImage res = agent.GetContactImageWithSize(contactId, width, height);

GetOutputFromBatch(Integer)

Gets the output of a batchtask as a stream

NSStream GetOutputFromBatch(Integer batchTaskId)

Returns: CRMScript.NetServer.NSStream Example:

NSBLOBAgent agent;
Integer batchTaskId;
NSStream res = agent.GetOutputFromBatch(batchTaskId);

GetPersonImage(Integer)

Returns the person image that is displayed in the CRM application.

NSImage GetPersonImage(Integer personId)

Returns: CRMScript.NetServer.NSImage - The image as a System.Drawing.Image. (If the the image is returned over web services, the stream is returned as a Base64 encoded string.). Example:

NSBLOBAgent agent;
Integer personId;
NSImage res = agent.GetPersonImage(personId);

GetPersonImageWithSize(Integer,Integer,Integer)

Returns the person image that is displayed in the CRM application with a specified maximum size.

NSImage GetPersonImageWithSize(Integer personId, Integer width, Integer height)

Returns: CRMScript.NetServer.NSImage - The image as a System.Drawing.Image. (If the the image is returned over web services, the stream is returned as a Base64 encoded string.). Example:

NSBLOBAgent agent;
Integer personId;
Integer width;
Integer height;
NSImage res = agent.GetPersonImageWithSize(personId, width, height);

GetProductImage(Integer)

Returns the product image (rank=1) that is displayed in the CRM application.

NSImage GetProductImage(Integer productId)

Returns: CRMScript.NetServer.NSImage - The image as a System.Drawing.Image. (If the the image is returned over web services, the stream is returned as a Base64 encoded string.). Example:

NSBLOBAgent agent;
Integer productId;
NSImage res = agent.GetProductImage(productId);

GetProductThumbnail(Integer)

Returns the product thumbnail that is displayed in the CRM application.

NSImage GetProductThumbnail(Integer productId)

Returns: CRMScript.NetServer.NSImage - The image as a System.Drawing.Image. (If the the image is returned over web services, the stream is returned as a Base64 encoded string.). Example:

NSBLOBAgent agent;
Integer productId;
NSImage res = agent.GetProductThumbnail(productId);

GetProjectImage(Integer)

Returns the project image that is displayed in the CRM application.

NSImage GetProjectImage(Integer projectId)

Returns: CRMScript.NetServer.NSImage - The image as a System.Drawing.Image. (If the the image is returned over web services, the stream is returned as a Base64 encoded string.). Example:

NSBLOBAgent agent;
Integer projectId;
NSImage res = agent.GetProjectImage(projectId);

GetProjectImageWithSize(Integer,Integer,Integer)

Returns the project image that is displayed in the CRM application with a specified maximum size.

NSImage GetProjectImageWithSize(Integer projectId, Integer width, Integer height)

Returns: CRMScript.NetServer.NSImage - The image as a System.Drawing.Image. (If the the image is returned over web services, the stream is returned as a Base64 encoded string.). Example:

NSBLOBAgent agent;
Integer projectId;
Integer width;
Integer height;
NSImage res = agent.GetProjectImageWithSize(projectId, width, height);

GetQuoteLineImage(Integer)

Returns the quoteline image (rank=1) that is displayed in the CRM application.

NSImage GetQuoteLineImage(Integer quoteLineId)

Returns: CRMScript.NetServer.NSImage - The image as a System.Drawing.Image. (If the the image is returned over web services, the stream is returned as a Base64 encoded string.). Example:

NSBLOBAgent agent;
Integer quoteLineId;
NSImage res = agent.GetQuoteLineImage(quoteLineId);

SaveBlobEntity(NSBlobEntity)

Updates the existing NSBlobEntity or creates a new NSBlobEntity if the ID parameter is 0.

NSBlobEntity SaveBlobEntity(NSBlobEntity blobEntity)

Returns: CRMScript.NetServer.NSBlobEntity - New or updated BlobEntity. Example:

NSBLOB agent;
NSBlobEntity thing = agent.CreateDefaultBlobEntity();
thing = agent.SaveBlobEntity(thing);

SaveImageStream(Integer,NSImage,String)

Stores an image in the database without linking it to a project or a person.

Integer SaveImageStream(Integer type, NSImage image, String description)

Returns: CRMScript.Global.Integer - The blob Id.

It is possible to ChangePersonImage or ChangeProjectImage to attach image later.

Example:

NSBLOBAgent agent;
Integer type;
NSImage image;
String description;
Integer res = agent.SaveImageStream(type, image, description);

SaveProjectImage(String,NSImage)

Saves a project image that is displayed in the CRM application’s project image selection dialog to the database.

Void SaveProjectImage(String description, NSImage image)

Returns: CRMScript.Global.Void

SetAppData(String,String)

Sets a CLOB (limited to a reasonable size by the mechanics of Web Services) according to a string key; ALSO limits to the current ApplicationToken if any.

Void SetAppData(String key, String data)

Returns: CRMScript.Global.Void

Existing data, if any, will be overwritten. Overwrite with a blank value to delete.

Example:

NSBLOBAgent agent;
String key;
String data;
agent.SetAppData(key, data);

SetBlobStream(Integer,NSStream)

Stores a binary object from its stream

Void SetBlobStream(Integer blobEntityId, NSStream stream)

Returns: CRMScript.Global.Void

SetContactImage(Integer,NSImage)

Stores the contact image that is displayed in the CRM application.

Void SetContactImage(Integer contactId, NSImage image)

Returns: CRMScript.Global.Void

SetPersonImage(Integer,NSImage)

Stores the person image that is displayed in the CRM application.

Void SetPersonImage(Integer personId, NSImage image)

Returns: CRMScript.Global.Void

SetProductImage(Integer,NSImage)

Stores the product image that is displayed in the CRM application. The image is scaled down to max 1000x1000. This method operates only the main (rank=1) image; future extensions may support multiple images. A thumbnail of size 75x75 is also automatically set.

Void SetProductImage(Integer productId, NSImage image)

Returns: CRMScript.Global.Void

SetProductThumbnail(Integer,NSImage)

Stores the product thumbnail that is displayed in the CRM application. The image is scaled down to max 200x200 pixels.

Void SetProductThumbnail(Integer productId, NSImage image)

Returns: CRMScript.Global.Void

SetProjectImage(Integer)

Stores the project image that is displayed in the CRM application.

Void SetProjectImage(Integer projectId, NSImage image)

Returns: CRMScript.Global.Void

​Constructors

​NSBLOBAgent()

​Methods

​ChangeContactImage(Integer,Integer)

​ChangePersonImage(Integer,Integer)

​ChangeProductImage(Integer,Integer)

​ChangeProjectImage(Integer,Integer)

​CleanupBatchTask(Integer)

​CreateDefaultBlobEntity()

​DeleteBlobEntity(Integer)

​GetAppData(String)

​GetBlobEntity(Integer)

​GetBlobEntityOnContact(Integer)

​GetBlobEntityOnCountry(Integer)

​GetBlobEntityOnPerson(Integer)

​GetBlobEntityOnProduct(Integer)

​GetBlobEntityOnProject(Integer)

​GetBlobStream(Integer)

​GetChatImageWithSize(Integer,Integer,Integer)

​GetContactImage(Integer)

​GetContactImageWithSize(Integer,Integer,Integer)

​GetOutputFromBatch(Integer)

​GetPersonImage(Integer)

​GetPersonImageWithSize(Integer,Integer,Integer)

​GetProductImage(Integer)

​GetProductThumbnail(Integer)

​GetProjectImage(Integer)

​GetProjectImageWithSize(Integer,Integer,Integer)

​GetQuoteLineImage(Integer)

​SaveBlobEntity(NSBlobEntity)

​SaveImageStream(Integer,NSImage,String)

​SaveProjectImage(String,NSImage)

​SetAppData(String,String)

​SetBlobStream(Integer,NSStream)

​SetContactImage(Integer,NSImage)

​SetPersonImage(Integer,NSImage)

​SetProductImage(Integer,NSImage)

​SetProductThumbnail(Integer,NSImage)

​SetProjectImage(Integer)

Constructors

NSBLOBAgent()

Methods

ChangeContactImage(Integer,Integer)

ChangePersonImage(Integer,Integer)

ChangeProductImage(Integer,Integer)

ChangeProjectImage(Integer,Integer)

CleanupBatchTask(Integer)

CreateDefaultBlobEntity()

DeleteBlobEntity(Integer)

GetAppData(String)

GetBlobEntity(Integer)

GetBlobEntityOnContact(Integer)

GetBlobEntityOnCountry(Integer)

GetBlobEntityOnPerson(Integer)

GetBlobEntityOnProduct(Integer)

GetBlobEntityOnProject(Integer)

GetBlobStream(Integer)

GetChatImageWithSize(Integer,Integer,Integer)

GetContactImage(Integer)

GetContactImageWithSize(Integer,Integer,Integer)

GetOutputFromBatch(Integer)

GetPersonImage(Integer)

GetPersonImageWithSize(Integer,Integer,Integer)

GetProductImage(Integer)

GetProductThumbnail(Integer)

GetProjectImage(Integer)

GetProjectImageWithSize(Integer,Integer,Integer)

GetQuoteLineImage(Integer)

SaveBlobEntity(NSBlobEntity)

SaveImageStream(Integer,NSImage,String)

SaveProjectImage(String,NSImage)

SetAppData(String,String)

SetBlobStream(Integer,NSStream)

SetContactImage(Integer,NSImage)

SetPersonImage(Integer,NSImage)

SetProductImage(Integer,NSImage)

SetProductThumbnail(Integer,NSImage)

SetProjectImage(Integer)