|
SIP Endpoint SDK for OS X
|
#import <GSEndpoint.h>
Public Member Functions | |
| (void) | - activate |
| (BOOL) | - configure |
| (void) | - printConfigSettings |
| (void) | - printConfigFile: |
| (GSResult) | - setConfigSettingValue:forKey: |
| (NSString *) | - getConfigSettingForKey: |
| (void) | - stop |
| (void) | - shutdown |
| (id< GSSessionService >) | - sessionControlService |
| (id< GSStatisticsService >) | - statisticsService |
Properties | |
| NSString * | endpointSdkVersion |
| NSMutableDictionary * | configuration |
| id< GSLogger > | logger |
| GSEndpointState | state |
| id< GSConnectionManager > | connectionManager |
| id< GSSessionManager > | sessionManager |
| id< GSDeviceManager > | deviceManager |
| id < GSEndpointNotificationDelegate > | notificationDelegate |
| id< GSEndpointPolicyDelegate > | policyDelegate |
| NSMutableArray * | gsTestControl |
This protocol defines sip endpoint functionality. It should be used to configure the sip endpoint and work with all active connections, sessions, and devices.
Definition at line 21 of file GSEndpoint.h.
| - (void) activate |
Enables all configured connections.
| - (BOOL) configure |
Configure endpoint.
| - (NSString*) getConfigSettingForKey: | (NSString *) | key |
Get endpoint configuration setting
| key |
| - (void) printConfigFile: | (NSString *) | fileName |
Logs out configuration file.
| fully | qualified file name. |
| - (void) printConfigSettings |
Logs out all configuration settings.
| - (id<GSSessionService>) sessionControlService |
| - (GSResult) setConfigSettingValue: | (NSString *) | value | |
| forKey: | (NSString *) | key | |
Set endpoint configuration setting
| value | |
| key |
| - (void) shutdown |
Destroy endpoint and provider.
| - (id<GSStatisticsService>) statisticsService |
| - (void) stop |
Destroy endpoint.
|
readwritenonatomicretain |
Used to provide SIP Endpoint SDK configuration settings.
Definition at line 33 of file GSEndpoint.h.
|
readwritenonatomicretain |
Get/set instance of the connection manager object which handles all connection information, stores all related policies and provides notifications about connection state. Returns a Genesys GSConnectionManager implemenation as the default.
Reimplemented in GSSipEndpoint.
Definition at line 53 of file GSEndpoint.h.
|
readwritenonatomicretain |
Get/set instance of the device manager object which handles all connected input/output devices, stores all related policies and provides notifications about device state. Returns a Genesys GSDeviceManager implemenation as the default
Reimplemented in GSSipEndpoint.
Definition at line 69 of file GSEndpoint.h.
|
readwritenonatomicretain |
Used to provide SIP Endpoint SDK version description.
Reimplemented in GSSipEndpoint.
Definition at line 28 of file GSEndpoint.h.
|
readwritenonatomicretain |
Get/set array of GSTestControl elements if any connectivity has ctrl setting configured that means the connectivity can request a test phone to delegate control on particualar dn/user and then after getting delegated event will link this connection for test phone
Reimplemented in GSSipEndpoint.
Definition at line 88 of file GSEndpoint.h.
|
readwritenonatomicretain |
|
readwritenonatomicretain |
Get/set the delegate responsible for notifications about endpoint state.
Reimplemented in GSSipEndpoint.
Definition at line 74 of file GSEndpoint.h.
|
readwritenonatomicretain |
Get/set the delegate responsible for dictating endpoint policy.
Reimplemented in GSSipEndpoint.
Definition at line 79 of file GSEndpoint.h.
|
readwritenonatomicretain |
Get/set instance of the session manager object which handles all session data, stores all related policies and provides notifications about session state. Returns a Genesys GSSessionManager implemenation as the default.
Reimplemented in GSSipEndpoint.
Definition at line 61 of file GSEndpoint.h.
|
readwritenonatomicassign |
Returns the current endpoint status. The endpoint is considered "Active" if at least one connection is registered.
Reimplemented in GSSipEndpoint.
Definition at line 45 of file GSEndpoint.h.