AgentSdkCoreProtocol

Extends Protocol:
NSObject
Declared In:

Introduction

Implement this delegation protocol to receive feedback on core events for your registered delegates with AgentSdkCore.



Methods

-agentProfileSetting:changed:
-appCatalogLinkReceived:
-appWipe
-chatMessageReceived:
-connectionStatusUpdate:errorMsg:
-deviceNameUpdate:
-eventLog:
-injectingChar:
-mouseEvent:
-remoteViewStatusUpdate:
-termsAndConditionStatusUpdate:tcLink:tcAcceptedDate:

agentProfileSetting:changed:


@optional

- (void) agentProfileSetting:(NSString *)key changed:(NSString *)value;
Parameters
key

Contains key for profile setting

value

Contains new value for changed profile setting

Discussion

Called when the agent profile setting is changed.

Availability
v11

appCatalogLinkReceived:


@optional

- (void) appCatalogLinkReceived:(NSString *)message;
Parameters
message

Contains URL to web app catalog. This is only used for backwards compatibility with pre-version 10 servers.

Discussion

When the SDK-enabled App receives the application catalog URL, this event is triggered. The message is only used for BACKWARDS Compabilitiy with pre-version 10 servers. To get the actual post 10 app catalog, the API is part of the app catalog API. This function is here becuase it is of special case needs to access to special functions.

Availability
v11

appWipe


@optional

- (void) appWipe;
Discussion

Server sent request to wipe app data because device has been deleted from the system. App should delete any state/date and reset itself. After this command, app will be disconnected from server and will be required to enroll again.

Availability
v11

chatMessageReceived:


@optional

- (void) chatMessageReceived:(NSString*)message;
Parameters
message

Constains message sent by admin during remote chat.

Discussion

Called when a chat message is recieved from the administrator via Web Console. This is only valid if remote view session has started.

Availability
v11

connectionStatusUpdate:errorMsg:


@optional

- (void) connectionStatusUpdate:(ConnectionStatus)status errorMsg:(NSString*)error;
Parameters
status

Contains connection status.

error

Contains error message containing brief description in case of connection failure.

Discussion

Called as a result of connectToDS operation. Disconnect will be sent if already connected.

Availability
v11

deviceNameUpdate:


@optional

- (void) deviceNameUpdate:(NSString *)deviceName;
Parameters
deviceName

Contains updated device name

Discussion

Called when the device name is updated.

Availability
v11

eventLog:


@optional

- (void) eventLog:(AgentLogEvent*)agentLogEvent;
Parameters
agentLogEvent

Contains event log message from SDK.

Discussion

Called when an event occurs from SDK. This method is meant for debugging.

Availability
v11

injectingChar:


@optional

- (void)injectingChar:(NSDictionary *)info;
Parameters
info

Constains keyCoode and keyStatus. keyCode : a, b, c etc , keyStatus : Shift, Command, Control , Shift+Command etc

Discussion

Called when a key event is recieved from the administrator via Web Console while taking RC. This is only valid if remote view session has started.

Availability
v14.1

mouseEvent:


@optional

- (void)mouseEvent:(NSDictionary *)info;
Parameters
info

Constains cordiname x, y and type . cordiname : x,y (position where clicked) , type : PKK_MOUSE_EVENTS

Discussion

Called when a mouse event is recieved from the administrator via Web Console while taking RC. This is only valid if remote view session has started.

Availability
v14.1

remoteViewStatusUpdate:


@optional

- (void) remoteViewStatusUpdate:(RemoteViewStatus)status;
Parameters
status

Contains current status of remote view.

Discussion

Called when administrator starts or stops a remote view session via Web Console.

Availability
v11

termsAndConditionStatusUpdate:tcLink:tcAcceptedDate:


@optional

- (void) termsAndConditionStatusUpdate:(TermsAndConditionStatus)status tcLink:(NSString *)link tcAcceptedDate:(NSDate *)acceptedDate;
Parameters
status

Contains Terms and Conditions Status. Codes used here are Accepted, Pending and Cancelled.

link

Contains URL for user to visit for acceptance of Terms and Conditions if status is Accepted or Pending, else parameter will be nil.

acceptedDate

Contains Date of acceptance if status is Accepted.

Discussion

Called from Deployment Server when Terms and Conditions are updated.

Availability
v11