REST.Backend.EMSApi.TEMSClientAPI Methods
InheritedProtected
_AddRef | protected | Called when an application uses a component interface. |
_Release | protected | Called when an application releases a component interface. |
AddAppSecret | protected | |
AddAuthHeader | protected | |
AddAuthParameters | public | Adds the configured authentication data to the headers of the specified request. |
AddMasterKey | protected | Adds the specified master key to the headers of the specified request. |
AddResource | protected | Adds to the EMS server a resource of the specified resource type with the specified data. |
AddSessionToken | protected | Adds the specified application secret and session token to the headers of the specified request. |
AddTenantId | protected | |
AddUser | public | Adds to the EMS server a user with the specified username, password and additional data. |
AddUsersToGroup | public | Requests to add the specified users to the specified group. Returns True if the EMS server applies the requested change or False if the EMS server returns an error. |
AfterConstruction | public | Responds after the last constructor has executed. |
AppHandshake | public | Requests the version information of the EMS server and returns True if it receives the information successfully or False otherwise. |
ApplyConnectionInfo | public | |
Assign | public | Copies the contents of another similar object. |
AssignTo | protected | Copies the properties of an object to a destination object. |
AsyncSchedule | protected | Schedules asynch method calls. |
BeforeDestruction | public | Performs any necessary actions before the first destructor is called. |
BeginInvoke | public | Performs an asynchronous call to the method specified by either AProc or AFunc . |
CanObserve | protected | |
ChangeName | protected | Sets the private, internal storage for the Name property to the string passed in NewName . |
CheckDisposed | protected | This method is deprecated. |
CheckForResponseError | public | |
ClassInfo | public | Returns a pointer to the run-time type information (RTTI) table for the object type. |
ClassName | public | Returns a string indicating the type of the object instance (as opposed to the type of the variable passed as an argument). |
ClassNameIs | public | Determines whether an object is of a specific type. |
ClassParent | public | Returns the type of the immediate ancestor of a class. |
ClassType | public | Returns the class reference for the object's class. |
CleanupInstance | public | Performs finalization on long strings, variants, and interface variables within a class. |
Create | public | |
CreateAndroidInstallationObject | public | |
CreateGroup | public | Adds to the EMS server a group with the specified name and data. |
CreateHTTPException | protected | |
CreateInstallationObject | protected | |
CreateIOSInstallationObject | public | |
DefaultHandler | public | Provides the interface for a method that processes message records. |
DefineProperties | protected | Designates methods for storing an object's unpublished data on a stream such as a form file. |
DeleteGroup | public | Requests the deletion of the specified group from the EMS server and returns True on success or False otherwise. |
DeleteInstallation | public | Sends a deletion request to the EMS server for the specified installation. |
DeleteResource | protected | Sends a deletion request to the EMS server for the specified resource. |
DeleteUser | public | Requests the deletion of the specified user from the EMS server and returns True on success or False otherwise. |
Destroy | public | |
DestroyComponents | public | Destroys all owned components. |
Destroying | public | Indicates that the component and its owned components are about to be destroyed. |
Dispatch | public | Calls message-handling methods for the object, based on the contents of the Message parameter. |
DisposeOf | public | DisposeOf forces the execution of the destructor code in an object. |
DoAddAuthParameters | protected | Adds the configured authentication data to the headers of the specified request. |
EndFunctionInvoke | public | Blocks the caller until the specified ASyncResult completes. |
EndInvoke | public | Blocks the caller until the specified ASyncResult completes. |
Equals | public | Checks whether the current instance and the Obj parameter are equal. |
ExecuteAction | public | Executes an action. |
FieldAddress | public | Returns the address of a published object field. |
FindComponent | public | Indicates whether a given component is owned by the component. |
Free | public | Destroys an object and frees its associated memory, if necessary. |
FreeInstance | public | Deallocates memory allocated by a previous call to the NewInstance method. |
FreeNotification | public | Ensures that AComponent is notified that the component is going to be destroyed. |
FreeOnRelease | public | Frees the interface reference for components that were created from COM classes. |
GetActualAuthentication | protected | |
GetChildOwner | protected | Returns the owner of a child component being read from a stream. |
GetChildParent | protected | Returns the parent or, if there is no parent, returns the owner of a child component being read from a stream. |
GetChildren | protected | Enumerates all child components. |
GetDeltaStreams | protected | |
GetDisposed | protected | Getter for the Disposed property. |
GetEnumerator | public | Returns a TComponent enumerator. |
GetHashCode | public | Returns an integer containing the hash code. |
GetIDsOfNames | protected | Maps a single member and an optional set of argument names to a corresponding set of integer dispatch identifiers (dispIDs). |
GetInterface | public | Retrieves a specified interface. |
GetInterfaceEntry | public | Returns the entry for a specific interface implemented in a class. |
GetInterfaceTable | public | Returns a pointer to a structure containing all of the interfaces implemented by a given class. |
GetNamePath | public | Returns a string used by the Object Inspector. |
GetObservers | protected | Getter of Observers. |
GetOwner | protected | Returns the owner of a component. |
GetParentComponent | public | Returns the containing component. |
GetTypeInfo | protected | Retrieves the type information for an object. |
GetTypeInfoCount | protected | Returns the number of type information interfaces that an object provides (either 0 or 1). |
GroupFromObject | protected | |
HasParent | public | Verifies whether the component has a parent. |
InheritsFrom | public | Determines the relationship of two object types. |
InitInstance | public | Initializes a newly allocated object instance to all zeros and initializes the instance's virtual method table pointer. |
InsertComponent | public | Establishes the component as the owner of a specified component. |
InstallationFromObject | protected | |
InstanceSize | public | Returns the size in bytes of each instance of the object type. |
Invoke | protected | Provides access to Automation properties and methods when the component wraps an Automation object. |
IsImplementorOf | public | Indicates whether the component implements a specified interface. |
Loaded | protected | Initializes the component after the form file has been read into memory. |
Login | public | Stores the specified session authentication token to use it on future requests. |
LoginFromObject | protected | Returns an instance of TLogin built from the specified username and login data from the EMS server. |
LoginUser | public | Logs into the EMS server and obtains authentication data that TEMSClientAPI uses in future requests. |
Logout | public | |
LogoutUser | public | Logs out of the EMS server. |
MakeLoginResource | protected | |
MetaDataFromObject | protected | |
MethodAddress | public | Returns the address of a class method by name. |
MethodName | public | Returns the name of a class method by address. |
ModuleFromObject | protected | |
NewInstance | public | Allocates memory for an instance of an object type and returns a pointer to that new instance. |
Notification | protected | Forwards notification messages to all owned components. |
ObserverAdded | protected | |
operator () | public | C++ conversion of a TComponent into a System.Classes.IInterfaceComponentReference or a System.IInterface, depending on casting. |
PushBody | protected | Sends the specified EMS push message payload to the EMS server. |
PushBroadcast | public | Sends the specified EMS push message payload to the EMS server so that the EMS server redirects the message to all devices. |
PushStatusFromObject | protected | |
PushToChannels | public | Sends the specified EMS push message payload to the EMS server so that the EMS server redirects the message to the specified channels. |
PushToTarget | public | Sends the specified EMS push message payload to the EMS server so that the EMS server redirects the message to the specified target. |
PushWhere | public | Sends the specified EMS push message payload to the EMS server so that the EMS server redirects the message to the targets that match the specified "where" clause. |
PutResource | protected | Sends the specified data to replace the specified resource on the EMS server. |
QualifiedClassName | public | Returns the qualified name of the class. |
QueryGroups | public | Queries the EMS server for a list of groups. |
QueryInstallations | public | Queries the EMS server for a list of installations. |
QueryInterface | protected | Returns a reference to a specified interface if the current component supports that interface. |
QueryModuleName | public | Queries the EMS server for the data of a module with the specified module name and returns True if a module with the specified module name exists in the EMS server or False otherwise. |
QueryModuleResources | public | Queries the EMS server for a list of module resources. |
QueryModules | public | Queries the EMS server for a list of modules. |
QueryResource | protected | Queries the EMS server for a list of resources of the specified resource type. |
QueryUserName | public | Queries the EMS server for the data of a user with the specified username and returns True if a user with the specified username exists in the EMS server or False otherwise. |
QueryUsers | public | Queries the EMS server for a list of users. |
ReadState | protected | Reads the state of the component. |
ReferenceInterface | public | Establishes or removes internal links that cause this component to be notified when the implementer of a specified interface is destroyed. |
RegisterModule | public | Adds to the EMS server a module with the specified name, protocol, protocol properties, details and resources. |
RemoveComponent | public | Removes a specified component specified from the component's Components list. |
RemoveFreeNotification | public | Disables the destruction notification that was enabled by FreeNotification. |
RemoveFreeNotifications | protected | Notifies all owned components of the owner component's imminent destruction. |
RemoveUsersFromGroup | public | Requests to remove the specified users from the specified group. Returns True if the EMS server applies the requested change or False if the EMS server returns an error. |
ResourceFromObject | protected | |
RetrieveCurrentUser | public | Requests your user information from the EMS server and returns True if it receives the information successfully or False otherwise. |
RetrieveFields | protected | Queries the EMS server for a list of fields that the specified resource type support. |
RetrieveGroup | public | Requests the information of a group from the EMS server and returns True if it receives the information successfully or False otherwise. |
RetrieveGroupsFields | public | Queries the EMS server for a list of fields that the EMS server supports for groups. |
RetrieveGroupsNames | public | Returns an array with the names of groups that are registered in the EMS server. |
RetrieveInstallation | public | Requests the information of an installation from the EMS server and returns True if it receives the information successfully or False otherwise. |
RetrieveInstallationsChannelNames | public | Returns a list with the names of the installation channels that are registered in the EMS server. |
RetrieveInstallationsFields | public | Queries the EMS server for a list of fields that the EMS server supports for installations. |
RetrieveModule | public | Requests the information of a module from the EMS server and returns True if it receives the information successfully or False otherwise. |
RetrieveModuleResource | public | Requests the information of a module resource from the EMS server and returns True if it receives the information successfully or False otherwise. |
RetrieveModuleResourcesFields | public | Queries the EMS server for a list of fields that the EMS server supports for module resources. |
RetrieveModulesFields | public | Queries the EMS server for a list of fields that the EMS server supports for modules. |
RetrieveUser | public | Requests the information of a user from the EMS server and returns True if it receives the information successfully or False otherwise. |
RetrieveUserGroups | public | Returns an array with the IDs of the groups where the user with the specified ID belongs. |
RetrieveUsersFields | public | Queries the EMS server for a list of fields that the EMS server supports for users. |
RetrieveUsersNames | public | Returns an array with the usernames that are registered in the EMS server. |
SafeCallException | public | Handles exceptions in methods declared using the safecall calling convention. |
SetAncestor | protected | Clears or sets csAncestor state in the component's ComponentState property. |
SetChildOrder | protected | Sets the visual ordering of a child control. |
SetDesigning | protected | Ensures that components inserted at design time have their design-mode flag set. |
SetDesignInstance | protected | Ensures that components inserted at design time have their design-mode flag set. |
SetInline | protected | Sets the csInline bit of the component's ComponentState property. |
SetName | protected | Sets the value of the Name property. |
SetParentComponent | protected | Sets the parent component. |
SetSubComponent | public | Identifies whether the component is a subcomponent. |
SignupUser | public | Registers a user account on the EMS server with the specified username and password, and logs into the EMS server to obtains authentication data that you can use in future requests. |
ToString | public | Returns a string containing the class name. |
UnitName | public | Returns the name of the unit where the class is defined. |
UnitScope | public | Returns the class's unit scope. |
UnregisterModule | public | Sends a deletion request to the EMS server for the specified module. |
UnregisterModuleResource | public | Sends a deletion request to the EMS server for the specified resource of the specified module. |
UpdateAction | public | Updates the state of an action. |
Updated | protected | Clears the csUpdating state in the component's ComponentState property when the component finishes updating. |
UpdatedAtFromObject | protected | |
UpdateGroup | public | Replaces the existing information about the specified group with the specified information. |
UpdateInstallation | public | Replaces the existing information about the specified installation with the specified information. |
UpdateModule | public | Replaces the existing information about the specified module with the specified information. |
UpdateModuleResource | public | Replaces the existing information about the specified module resource with the specified information. |
UpdateRegistry | protected | Provides the interface for a method that adds type library and version information to the Registry on components that implement COM interfaces. |
UpdateUser | public | Replaces the existing information about the specified user with the specified information. |
Updating | protected | Sets the csUpdating state in the component's ComponentState property. |
UploadInstallation | public | Adds to the EMS server a new installation with the specified data. |
UserFromObject | public | |
ValidateContainer | protected | Determines whether an object can be inserted into a container. |
ValidateInsert | protected | Provides the interface for a method that validates a child component before it is inserted. |
ValidateRename | protected | Ensures that renaming an owned component does not create a name conflict. |
WriteState | protected | Writes the state of the component. |