TTMSFNCCloudGoogleFirebaseObjectDatabase
Usage
A component that provides access to the Google Firebase Database service. It allows to read, create, update & delete data.
Authorization information
Client ID, CallBack URL, Project
Properties
Property name | Description |
---|---|
DatabaseName | Required to be assigned with the name of the Firebase database related to the authenticated user. Detailed information is available at: http://www.tmssoftware.com/site/cloudkey.asp |
TableName | Assign the name of the table that is used to retrieve, add, update and remove with the methods indicated below. |
GeneralRules | Contains the general rules specified for the Firebase Database. Use the GetRules method to fill the list with existing rules. |
IndexRules | Contains the index rules specified for the Firebase Database. These are required when using one of the Query* methods. Use the GetRules method to fill the list with existing rules. Use the AddIndexRule method to add a rule. |
Methods
Property name | Description |
---|---|
InsertObject | Insert a new object in the Table specified in the TableName property. |
WriteObject | Update an existing object in the Table specified in the TableName property. |
ReadObject | Retrieve an existing object based on it’s ID from the Table specified in the TableName property. |
DeleteObject | Delete an existing object from the Table specified in the TableName property. |
InsertList | Insert a list of objects in the Table specified in the TableName property. |
WriteList | Updates a list of objects in the Table specified in the TableName property. |
ReadList | Retrieves a list of objects from the Table specified in the TableName property. |
DeleteList | Deletes a list of objects from the Table specified in the TableName property. |
QueryList(PropertyName, KeyWord: string) QueryList(PropertyName, KeyWord: string; AList: TTMSFNCCloudGoogleFireBaseObjectList) QueryList(PropertyName, KeyWord: boolean) QueryList(PropertyName, KeyWord: boolean; AList: TTMSFNCCloudGoogleFireBaseObjectList) QueryList(PropertyName, KeyWord: double) QueryList(PropertyName, KeyWord: double; AList: TTMSFNCCloudGoogleFireBaseObjectList) |
Retrieves a filtered list of objects from the Table specified in the TableName property. The list is filtered on the field specified in the PropertyName value based on the KeyWord value. The KeyWord can be a string, Boolean or integer/double value depending on the content of the field.Note it is required that the PropertyName is present in the list of IndexRules . Use the AddIndexRule to add a new PropertyName . |
QueryList(PropertyName, StartAt, EndAt: string) QueryList(PropertyName, StartAt, EndAt: string; AList:TTMSFNCCloudGoogleFireBaseObjectList); |
Retrieves a filtered list of objects from the Table specified in the TableName property. The list is filtered on the field specified in the PropertyName value based on the StartAt and EndAt values. For example if the StartAt is “A” and the EndAt is “A” the result will contain a list of all objects for which the PropertyName field text starts with “A” . Note it is required that the PropertyName is present in the list of IndexRules . Use the AddIndexRule to add a new PropertyName . |
AddIndexRule | Add a new rule to the list of IndexRules and submit the new data to the Firebase Database rules.If the rule based on the TableName and PropertyName already exists, no data is changed.When using one of the Query* methods it is required that the PropertyName (= Fieldname ) has been added to the list of index rules. |
DeleteTable | Delete all objects and table object itself specified in the ATableName parameter value. |
IDExists | Returns if an object with the specified ID parameter value exists in the Table specified with the TableName property value. |
SetRules | Submits the data from the GeneralRules and IndexRules to the Firebase Database . |