Sip Endpoint SDK for Apple OS
<GSEndpoint> Protocol Reference

#import <GSEndpoint.h>

List of all members.

Public Member Functions

(void) - configureWithDictionary:
(void) - activate
(id< GSSessionControlService >) - sessionControlService

Properties

GSEndpointState state
id< GSConnectionManagerconnectionManager
id< GSSessionManagersessionManager
id< GSDeviceManagerdeviceManager
id
< GSEndpointNotificationDelegate
notificationDelegate
id< GSEndpointPolicyDelegatepolicyDelegate

Detailed Description

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 14 of file GSEndpoint.h.


Member Function Documentation

- (void) activate

Enables all configured connections.

- (void) configureWithDictionary: (NSDictionary *)  configuration

Used to configure all sip endpoint parameters. This method should be called before any other actions are performed.

Parameters:
configurationa dictionary object containing all configuration information.
- (id<GSSessionControlService>) sessionControlService
Returns:
an instance of the session control service to be used for first party call control

Property Documentation

- (id<GSConnectionManager>) connectionManager [read, write, retain]

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.

See also:
GSConnectionManager

Definition at line 38 of file GSEndpoint.h.

- (id<GSDeviceManager>) deviceManager [read, write, retain]

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

See also:
GSDeviceManager

Definition at line 54 of file GSEndpoint.h.

- (id<GSEndpointNotificationDelegate>) notificationDelegate [read, write, assign]

Get/set the delegate responsible for notifications about endpoint state.

Definition at line 59 of file GSEndpoint.h.

- (id<GSEndpointPolicyDelegate>) policyDelegate [read, write, assign]

Get/set the delegate responsible for dictating endpoint policy.

Definition at line 64 of file GSEndpoint.h.

- (id<GSSessionManager>) sessionManager [read, write, retain]

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.

See also:
GSSessionManager

Definition at line 46 of file GSEndpoint.h.

- (GSEndpointState) state [read, write, assign]

Returns the current endpoint status. The endpoint is considered "Active" if at least one connection is registered.

Definition at line 30 of file GSEndpoint.h.


The documentation for this protocol was generated from the following file: