Class NSPocketAgent
Agent with Pocket specific functionality.
Examples
NSPocketAgent agent;
agent.callMethod(arg1, arg2);Constructors
NSPocketAgent()
Agent with Pocket specific functionality.
Declaration
NSPocketAgentExamples
NSPocketAgent agent;
agent.callMethod(arg1, arg2);Methods
GetPocketStartupData(String[])
Returns start-up data for SuperOffice Pocket CRM
Declaration
NSPocketStartupData GetPocketStartupData(String[] tables, DateTime currentClientTime)Examples
NSPocketAgent agent;
String[] tables;
DateTime currentClientTime;
NSPocketStartupData res = agent.GetPocketStartupData(tables, currentClientTime);Parameters
| Type | Name | Description |
| String[] | tables | |
| currentClientTime |
Returns
| Type | Description |
| NSPocketStartupData |
GetPushNotificationTagsForDevice(String)
Retrieves current tag value for a device
Declaration
String GetPushNotificationTagsForDevice(String deviceIdentifier)Examples
NSPocketAgent agent;
String deviceIdentifier;
String res = agent.GetPushNotificationTagsForDevice(deviceIdentifier);Parameters
| Type | Name | Description |
| String | deviceIdentifier |
Returns
| Type | Description |
| String |
GetRegisteredDevices(Integer)
Retrieves all registered devices for an associate
Declaration
NSPocketDeviceInfo[] GetRegisteredDevices(Integer associateId)Parameters
| Type | Name | Description |
| Integer | associateId |
Returns
| Type | Description |
| NSPocketDeviceInfo[] |
RegisterDeviceForPushNotification(NSPocketDeviceInfo)
Registers a device that should receive push notifications when notable events occur
Declaration
Void RegisterDeviceForPushNotification(NSPocketDeviceInfo deviceInfo)Parameters
| Type | Name | Description |
| NSPocketDeviceInfo | deviceInfo |
Returns
| Type | Description |
| Void |
RunAppointmentAlarmBroker()
Executes the AppointmentAlarmBroker once
Declaration
Void RunAppointmentAlarmBroker()Returns
| Type | Description |
| Void |
SendPushNotification(Integer[],PocketNotificationMessage)
Sends a push notification to one or more associates
Declaration
Void SendPushNotification(Integer[] associateIds, PocketNotificationMessage message)Parameters
| Type | Name | Description |
| Integer[] | associateIds | |
| message |
Returns
| Type | Description |
| Void |
SetPushNotificationTagsForDevice(String,String)
Declaration
Void SetPushNotificationTagsForDevice(String deviceIdentifier, String tags)Parameters
| Type | Name | Description |
| String | deviceIdentifier | |
| String | tags | The notification events a device should receive push notifications for. |
Returns
| Type | Description |
| Void |