Classes

The following classes are available globally.

  • Service Class for Call. Retrieves notification from Notification Manager and redirects them to related classes. Sends reqiured callbacks to application layer.

    Since

    1.0.0
    See more

    Declaration

    Objective-C

    @interface CPCallService : NSObject <CPServiceProtocol>

    Swift

    class CPCallService : NSObject

  • Contains status information of the call.

    Since

    1.0.0
    See more

    Declaration

    Objective-C

    @interface CPCallState : NSObject

    Swift

    class CPCallState : NSObject

  • Class for media attributes of a Call.

    Since

    1.0.0
    See more

    Declaration

    Objective-C

    @interface CPMediaAttributes : NSObject

    Swift

    class CPMediaAttributes : NSObject

  • @brief This is the model class to set the custom payload numbers to given codecs in SDP.

    @since 1.4.0

    See more

    Declaration

    Objective-C

    @interface CPCodecToReplace : NSObject

    Swift

    class CPCodecToReplace : NSObject

  • Represents Base Codec Object

    Declaration

    Objective-C

    @interface CPCodec : NSObject

    Swift

    class CPCodec : NSObject

  • Undocumented

    See more

    Declaration

    Objective-C

    @interface CPAudioCodec : CPCodec

    Swift

    class CPAudioCodec : CPCodec

  • Represents Video Codec Object

    See more

    Declaration

    Objective-C

    @interface CPVideoCodec : CPCodec

    Swift

    class CPVideoCodec : CPCodec

  • This class stores available audio and video codecs list and also edits given SDP with preferred codecs for audio and video.

    @since: 1.0.0

    See more

    Declaration

    Objective-C

    @interface CPCodecSet : NSObject

    Swift

    class CPCodecSet : NSObject

  • OpusConfiguration class contains all configuration of Opus audio codec. Configurations can be set using this class instance.

    Since

    1.0.0
    See more

    Declaration

    Objective-C

    @interface CPAudioCodecConfiguration : NSObject

    Swift

    class CPAudioCodecConfiguration : NSObject

  • This class is used to set WebRTC Audio Session Configuration.

    Since

    1.0.0
    See more

    Declaration

    Objective-C

    @interface CPAudioSessionConfiguration : NSObject

    Swift

    class CPAudioSessionConfiguration : NSObject

  • @brief CPCallReceiveBandwidthLimit class can be used for setting limitation to receive bandwidth.

    @since 1.7.0

    See more

    Declaration

    Objective-C

    @interface CPCallReceiveBandwidthLimit : NSObject

    Swift

    class CPCallReceiveBandwidthLimit : NSObject

  • Utility class for common configuration management.

    Since

    1.0.0
    See more

    Declaration

    Objective-C

    @interface CPConfig : NSObject

    Swift

    class CPConfig : NSObject

  • This class stores ice servers list, adds a new iceServer and updates iceServer objects.

    @since 1.0.0

    See more

    Declaration

    Objective-C

    @interface CPICEServers : NSObject

    Swift

    class CPICEServers : NSObject

  • This class stores url, username and password of stun or turn servers.

    @since 1.0.0

    See more

    Declaration

    Objective-C

    @interface CPICEServer : NSObject

    Swift

    class CPICEServer : NSObject

  • An UriAddress is used to indicate the originator of a request, the destination of a request, and to specify any redirections of the request.

    Since

    1.0.0
    See more

    Declaration

    Objective-C

    @interface CPUriAddress : NSObject

    Swift

    class CPUriAddress : NSObject

  • Defines the cause of an error

    @since 1.0.0

    See more

    Declaration

    Objective-C

    @interface CPError : NSError

    Swift

    class CPError : NSError

  • Main instance for the CPaaS SDK. Contains service subscriptions, and manages authentication and configurations.

    Since

    1.0.0
    See more

    Declaration

    Swift

    @objc
public class CPaaS : NSObject

  • Manages authentication processes and connection.

    Since

    1.0.0
    See more

    Declaration

    Swift

    @objc
public class CPAuthenticationService : NSObject

  • This is an abstract base class used to access the common functionality and members of a MessageService conversation.

    See more

    Declaration

    Swift

    @objc
public class CPConversation : FetchedObjects

  • Base class for all message part types.

    Declaration

    Swift

    @objc
public class CPMessagePart : NSObject

  • Represents the text part of a message.

    See more

    Declaration

    Swift

    @objc
public class CPTextPart : CPMessagePart

  • Represents the Thumbnail part of a message.

    See more

    Declaration

    Swift

    @objc
public class CPThumbnailPart : NSObject

  • Represents a file part of a message.

    See more

    Declaration

    Swift

    @objc
public class CPFilePart : CPMessagePart

  • Used for presenting the application with message status notification information.

    See more

    Declaration

    Swift

    @objc
public class CPMessageStatus : NSObject

  • Abstract base class for accessing common functionality and members of CPInboundMessage and CPOutboundMessage

    See more

    Declaration

    Swift

    @objc
public class CPMessage : FetchedObjects

  • Represents a received message.

    See more

    Declaration

    Swift

    @objc
public class CPInboundMessage : CPMessage

  • Represents a sent message.

    See more

    Declaration

    Swift

    @objc
public class CPOutboundMessage : CPMessage

  • Undocumented

    See more

    Declaration

    Swift

    @objc
public class FetchOptions : NSObject

  • Undocumented

    See more

    Declaration

    Swift

    @objc
public class FetchCriteria : NSObject

  • Undocumented

    Declaration

    Swift

    @objc
public class FetchedObjects : NSObject

  • Undocumented

    See more

    Declaration

    Swift

    @objc
public class FetchResult : NSObject

  • This is an abstract base class used to access the common functionality of a messaging service such as SmsService or ChatService.

    See more

    Declaration

    Swift

    @objc
public class MessageService : NSObject

  • This class is used to manage an exchange of chat messages between two parties. Create a ChatConversation using the ChatService createConversation(withParticipant:) method

    See more

    Declaration

    Swift

    @objc
public class CPChatConversation : CPConversation

  • This class is used to manage a chat group.

    See more

    Declaration

    Swift

    @objc
public class CPChatGroup : NSObject

  • This class represents a chat session among members of a chat group.

    See more

    Declaration

    Swift

    @objc
public class CPChatGroupConversation : CPChatConversation

  • This class is used to manage a chat group invitation.

    See more

    Declaration

    Swift

    @objc
public class CPChatGroupInvitation : NSObject

  • This class is used to manage a participant of a chat group.

    See more

    Declaration

    Swift

    @objc
public class CPChatGroupParticipant : NSObject

  • This is an opaque class that gives the caller a means to cancel an activity the application initiated.

    See more

    Declaration

    Swift

    @objc
public class CPActivityHandle : NSObject

  • This class is used to manage chat services such as sending and receiving chat messages.

    See more

    Declaration

    Swift

    @objc
public class CPChatService : MessageService, CPServiceProtocol

  • Class describing an indication that a remote party is composing a message.

    See more

    Declaration

    Swift

    @objc
public class CPIsComposingMessage : NSObject

  • This class is used to manage SMS services such as sending and receiving SMS messages.

    See more

    Declaration

    Swift

    @objc
public class CPSmsService : MessageService, CPServiceProtocol

  • This class is used to manage presence services such as presence source publishing and presentity watching.

    See more

    Declaration

    Swift

    @objc
public class CPPresenceService : NSObject, CPServiceProtocol

  • This class represents a presence source. A presence source represents the presence status of a particular client.

    See more

    Declaration

    Swift

    @objc
public class CPPresenceSource : NSObject

  • Presentity object. Manages user’s presentity activity.

    See more

    Declaration

    Swift

    @objc
public class CPPresentity : NSObject

  • This class provides an opaque handle to be used to compare against presentity lists

    See more

    Declaration

    Swift

    @objc
public class CPPresentityListHandle : NSObject

  • This class represents a list of watched presentities.

    See more

    Declaration

    Swift

    @objc
public class CPPresentityList : NSObject

  • This class represents presentity status details.

    See more

    Declaration

    Swift

    @objc
public class PresenceActivity : NSObject

  • Contains Enums used by Address Book Service.

    Since

    1.0.0
    See more

    Declaration

    Swift

    @objc
public class CPAddressBook : NSObject

  • Manages address book lists.

    Since

    1.0.0
    See more

    Declaration

    Swift

    @objc
public class CPAddressBookList : NSObject

  • Store, manage and search contacts through address books, lists and directories.

    Since

    1.0.0
    See more

    Declaration

    Swift

    @objc
public class CPAddressBookService : NSObject, CPServiceProtocol

  • Holds the information about the selected contact.

    See more

    Declaration

    Swift

    @objc
public class CPContact : NSObject

  • Contains necessary information when search will be used.

    See more

    Declaration

    Swift

    @objc
public class CPSearch : NSObject

  • Contains key-value pair for directory search which specifies keyword for search and the field type where to search of contacts

    See more

    Declaration

    Swift

    @objc
public class CPSearchFilter : NSObject

  • Contains information about the directory search results.

    See more

    Declaration

    Swift

    @objc
public class CPSearchResult : NSObject

  • Contains informations about incoming call by parsing the VOIP push notification. The data in this class will be used to inform CallKit after receiving each voip notification

    Since

    2.5.0
    See more

    Declaration

    Swift

    @objc
public class CPCKInfo : NSObject

  • Manages push notifications and notifies relevant service.

    Since

    1.0.0
    See more

    Declaration

    Swift

    @objc
public class CPPushService : NSObject