Objects
 

The object commands allow you to access DMNSion Exchange objects.

 

Get

Syntax: get "msg id" locator(LF)

Gets the object defined in the locator string.

Results:

  • OK "msg id" "stream id"(LF)
    Returns an opened stream identifier if succesful.
  • FAIL "msg id"(LF)
    Unable to obtain the object.

 

Get data

Syntax: get.data "msg id" locator(LF)

Gets the data of the object defined in the locator string.

Results:

  • OK "msg id" "stream id"(LF)
    Returns an opened stream identifier if succesful.
  • FAIL "msg id"(LF)
    Unable to obtain the data.

 

Get scaled Image

Syntax: get.image "msg id" locator height width(LF)

Gets the image of the object defined in the locator string scaled to the heigth and width (in pixels) given.

Results:

  • OK "msg id" "stream id"(LF)
    Returns an opened stream identifier if succesful.
  • FAIL "msg id"(LF)
    Unable to obtain the object image.

 

Post

Syntax: post "msg id" locator "stream id"(LF)

Adds/replaces an object with the data provided..

Results:

  • OK "msg id"(LF)
    Object was succesfully added or replaced.
  • FAIL "msg id"(LF)
    Unable to add or replace the object.

 

Post

Syntax: post.data "msg id" locator "stream id"(LF)

Save the data for an object with the data provided..

Results:

  • OK "msg id"(LF)
    Object data was succesfully replaced.
  • FAIL "msg id"(LF)
    Unable to add or replace the data.

 

Validate

Syntax: validate "msg id" locator(LF)

Checks to see if you can access the object defined in the locator string.

Results:

  • OK "msg id"(LF)
    Object exists and can be accessed.
  • FAIL "msg id"(LF)
    Object cannot be accessed.

 

Delete

Syntax: delete "msg id" locator(LF)

Deletes the object defined in the locator string. Must be either a files or folder.

Results:

  • OK "msg id"(LF)
    Object has been deleted.
  • FAIL "msg id"(LF)
    Object cannot be deleted.

 

Folders

Syntax: folders "msg id" locator(LF)

List the folders found in the locator string. Only the folder portion of the locator is used.

Results:

  • OK "msg id" "folder #1" "folder #2" ... "folder #n"(LF)
    The list of folders is returned.
  • FAIL "msg id"(LF)
    List cannot be returned.

 

Files

Syntax: files "msg id" locator(LF)

List the files found in the locator string. Only the folder portion of the locator is used.

Results:

  • OK "msg id" "file #1" "file #2" ... "file #n"(LF)
    The list of files is returned.
  • FAIL "msg id"(LF)
    List cannot be returned.

 

Next: Streams