The BookmarkInformation type is used hold information about a bookmark that can be passed between the UX and APIs.
Below are the properties and their purpose.
- Guid UserGUID
- Default Value: Empty Guid.
- Intended Value: The guid of the user the bookmark belongs to.
- Guid SessionGUID
- Default Value: Empty Guid.
- Intended Value: The guid of the users current session.
- Guid BookmarkGUID
- Default Value: Empty Guid.
- Intended Value: The guid of the bookmark.
- string Name
- Default Value: Empty string.
- Intended Value: The name of the bookmark.
- string Category
- Default Value: Empty string.
- Intended Value: The category the bookmark belongs to (if applicable).
- string NewCategory
- Default Value: Empty string.
- Intended Value: The new category if the bookmark category is being changed.
- string Bookmarks
- Default Value: Empty string.
- Intended Value: XML that contains all the bookmarks for the current user.
- string Command
- Default Value: Empty string.
- Intended Value: The command that will be executed using this object in the API.
- string ErrorMessage
- Default Value: Empty string.
- Intended Value: Will contain an error message if something went wrong in the API so it can be handled on the UX.
