Classes
The following classes are available globally.
-
Represents a DTMF event that can be sent and received on an
See moreNXMConversation
. -
Represents a media event that is sent and received on an
See moreNXMConversation
. -
Represents a member event that is received on an
See moreNXMConversation
. -
Represents an image event that can be sent and received on an
See moreNXMConversation
. -
Information about an image, used in
See moreNXMImageEvent
Declaration
Objective-C
@interface NXMImageInfo : NSObject
Swift
class NXMImageInfo : NSObject
-
Represents a message event that is sent and received on an
See moreNXMConversation
. -
Represents a text event that is sent and received on an
See moreNXMConversation
. -
Represents a typing event that is sent and received on an
See moreNXMConversation
. -
Represents a custom event that can be sent and received on an
See moreNXMConversation
. -
This is a base class for the events that you and send and receive on an
See moreNXMConversation
.Declaration
Objective-C
@interface NXMEvent : NSObject
Swift
class NXMEvent : NSObject
-
The extra embedded info associated to an event.
See moreDeclaration
Objective-C
@interface NXMEventEmbeddedInfo : NSObject
Swift
class NXMEventEmbeddedInfo : NSObject
-
Represents a leg status event that can be received on an
See moreNXMConversation
. -
Represents a member message status event that can be received on an
See moreNXMConversation
. -
The NXMCall class is a
NXMConversation
for phone calls.Note
NXMCall can be and incoming call or outgoing call.Declaration
Objective-C
@interface NXMCall : NSObject
Swift
class NXMCall : NSObject
-
Directional data from Conversation Service (Conversation API).
See moreDeclaration
Objective-C
@interface NXMDirection : NSObject
Swift
class NXMDirection : NSObject
-
The NXMChannel is how the user connects to the
See moreNXMConversation
.Declaration
Objective-C
@interface NXMChannel : NSObject
Swift
class NXMChannel : NSObject
-
You use a NXMClient instance to utilise the services provided by the Conversation API in your app.
A session is the period during which your app is connected to NexmoConversation API. Sessions are established for the length of time given when the authToken was created.
Tokens also have a lifetime and can optionally be one-shot which will allow a single login only, before the authToken becomes invalid for another login attempt. If the authToken is revoked while a session is active the session may be terminated by the server. It is only possible to have a single session active over a socket.io connection at a time. Session multiplexing is not supported.
Note
The connection uses socket.io for both web and mobile clients. Upon a successful socket.io connection the client needs to authenticate itself. This is achieved by sending a login request via
-[NXMClient loginWithAuthToken:]
and get the answer in the delegate-[NXMClient setDelegate:]
.Warning
Unless otherwise specified, all the methods invoked by this client are executed asynchronously.
For the security of your Nexmo account, you should not embed directly your credentials authToken as strings in the app you submit to the App Store.
Remember to logout when needed in order to remove current user and disconnect from the underlying connection. Example usage:
See more[myClient logout];
Declaration
Objective-C
@interface NXMClient : NSObject
Swift
class NXMClient : NSObject
-
Object containing NXMClient endpoints configuration.
See moreDeclaration
Objective-C
@interface NXMClientConfig : NSObject
Swift
class NXMClientConfig : NSObject
-
The NXMConversation object represent a conversation.
See
NXMConversation can be used for messaging and media.Declaration
Objective-C
@interface NXMConversation : NSObject
Swift
class NXMConversation : NSObject
-
Helper methods.
See moreDeclaration
Objective-C
@interface NXMHelper : NSObject
Swift
class NXMHelper : NSObject
-
The NXMLeg object represent the member media state
See moreDeclaration
Objective-C
@interface NXMLeg : NSObject
Swift
class NXMLeg : NSObject
-
A class used to configure the logging settings of the SDK.
See moreDeclaration
Objective-C
@interface NXMLogger : NSObject
Swift
class NXMLogger : NSObject
-
The NXMMember class represents a Member of a Conversation (
See moreNXMConversation
). In order for a User to communicate through a Conversation they must join the Conversation through a membership.Declaration
Objective-C
@interface NXMMember : NSObject
Swift
class NXMMember : NSObject
-
An individual conversation member. Use this class to retrieve information about a NXMMemberSummary and display member info.
See moreDeclaration
Objective-C
@interface NXMMemberSummary : NSObject
Swift
class NXMMemberSummary : NSObject
-
The NXMMessage object represents a message to send.
See moreDeclaration
Objective-C
@interface NXMMessage : NSObject
Swift
class NXMMessage : NSObject
-
A class representing the payload from an incoming push notification.
See moreDeclaration
Objective-C
@interface NXMPushPayload : NSObject
Swift
class NXMPushPayload : NSObject
-
The events on an
See moreNXMConversation
are paginated so the NXMEventsPage class provides a way to traverse a Conversation’s events. -
The member summaries on an
See moreNXMConversation
are paginated so the NXMMembersSummaryPage class provides a way to traverse a Conversation’s member summaries. -
A base class for paginating objects, used in
See moreNXMEventsPage
andNXMConversationsPage
.Declaration
Objective-C
@interface NXMPage : NSObject
Swift
class NXMPage : NSObject
-
The NXMUser class represents a User. A User identifies a unique Nexmo user in the context of a Nexmo Application.
See moreDeclaration
Objective-C
@interface NXMUser : NSObject
Swift
class NXMUser : NSObject