TTMSFNCCloudCustomStellarDataStore Class
Implements Stellar Data Store authentication, table, metadata, entity, and blob operations.
API unit family: TMSFNCCloudStellarDataStore
Inherits from: TTMSFNCCustomCloudDataStore
Implements: ITMSFNCCloudStellarDataStore
Syntax
GeneratedPascalC++TTMSFNCCloudCustomStellarDataStore = class(TTMSFNCCustomCloudDataStore, ITMSFNCCloudStellarDataStore)
class PASCALIMPLEMENTATION TTMSFNCCloudCustomStellarDataStore : public TTMSFNCCustomCloudDataStore, public ITMSFNCCloudStellarDataStore
Properties
| Name |
Description |
| Entities |
Gets the entity collection for the active table. |
| MetaData |
Gets the metadata collection for the active table. |
| PageIndex |
Gets or sets the zero-based page index used by paged query requests. |
| ProjectId |
Gets or sets the active project identifier used by table and entity requests. |
| Projects |
Gets or sets the cached project collection. |
| PromiseInsertEntities |
Gets the entity collection used by pending promise-based insert operations. |
| TableId |
Gets or sets the active table identifier used by entity and metadata requests. |
| Tables |
Gets or sets the cached table collection. |
| User |
Gets or sets the cached authenticated user information. |
Methods
| Name |
Description |
| ActiveTable |
Returns the table that matches the active table identifier or table name. |
| AddMetaData |
Adds a metadata field to the active table. |
| AddMetaDataPromise |
Adds metadata and returns a promise that resolves when the request completes. |
| AddTable |
Adds a table definition to the service. |
| AddTablePromise |
Adds a table and returns a promise that resolves when the request completes. |
| CreateTable |
Creates a table with the specified name. |
| CreateTablePromise |
Creates a named table and returns a promise that resolves when the request completes. |
| Delete |
Deletes an entity by identifier. |
| DeleteAll |
Deletes all entities from the active table. |
| DeleteMetaData |
Deletes a metadata field by identifier. |
| DeleteTable |
Deletes a table by identifier. |
| DownloadAsFile |
Downloads a blob field to a file. |
| DownloadAsStream |
Downloads a blob field and returns the result through the stream event. |
| DownloadAsStreamSync |
Synchronously downloads a blob field as a stream. |
| GetMetaData |
Requests metadata for the active table. |
| GetMetaDataPromise |
Requests metadata and returns a promise that resolves when the request completes. |
| GetProjects |
Requests the projects available to the authenticated account. |
| GetProjectsPromise |
Requests projects and returns a promise that resolves when the request completes. |
| GetTables |
Requests the tables available in the active project. |
| GetTablesPromise |
Requests tables and returns a promise that resolves when the request completes. |
| GetTestTokensResult |
Evaluates the response returned by a token test request. |
| GetUser |
Requests information for the authenticated user. |
| GetUserPromise |
Requests the authenticated user and returns a promise that resolves when the request completes. |
| Insert |
Inserts an entity from a list of field values. |
| InsertPromise |
Inserts values and returns a promise that resolves when the request completes. |
| Query |
Queries entities from the active table using the current filters and sort order. |
| QueryPromise |
Queries entities and returns a promise that resolves when the request completes. |
| TableById |
Finds a table by numeric identifier. |
| TableByName |
Finds a table by name. |
| TableList |
Returns the available table names. |
| TestTokens |
Tests whether the current authentication tokens can access the service. |
| Update |
Updates an entity on the service. |
| UpdateAll |
Updates all entities in the active table with the specified field values. |
| UpdateAllPromise |
Updates all entities and returns a promise that resolves when the request completes. |
| UpdateMetaData |
Updates a metadata field by identifier. |
| UpdateMetaDataPromise |
Updates metadata by identifier and returns a promise that resolves when the request completes. |
| UpdatePromise |
Updates an entity and returns a promise that resolves when the request completes. |
| UpdateTable |
Updates the specified table definition. |
| UpdateTablePromise |
Updates a table and returns a promise that resolves when the request completes. |
| Upload |
Uploads a local file to a blob field. |
Events
| Name |
Description |
| OnAddMetaData |
Occurs when a metadata add request completes. |
| OnAddTable |
Occurs when a table add request completes. |
| OnDelete |
Occurs when an entity delete request completes. |
| OnDeleteAll |
Occurs when a delete-all request completes. |
| OnDeleteMetaData |
Occurs when a metadata delete request completes. |
| OnDeleteTable |
Occurs when a table delete request completes. |
| OnDownload |
Occurs when a blob download-to-file request completes. |
| OnDownloadStream |
Occurs when a blob download-to-stream request completes. |
| OnGetBlobData |
Occurs before blob data is retrieved and allows handlers to cancel the retrieval. |
| OnGetMetaData |
Occurs when a metadata request completes. |
| OnGetProjects |
Occurs when the project-list request completes. |
| OnGetTables |
Occurs when the table-list request completes. |
| OnGetUser |
Occurs when the authenticated-user request completes. |
| OnInsert |
Occurs when an entity insert request completes. |
| OnInsertAll |
Occurs when a multi-entity insert request completes. |
| OnQuery |
Occurs when an entity query request completes. |
| OnUpdate |
Occurs when an entity update request completes. |
| OnUpdateAll |
Occurs when an update-all request completes. |
| OnUpdateMetaData |
Occurs when a metadata update request completes. |
| OnUpdateTable |
Occurs when a table update request completes. |
| OnUpload |
Occurs when a blob upload request completes. |