TVOCallInvite Class Reference
| Inherits from | NSObject |
|---|---|
| Declared in | TVOCallInvite.h |
Overview
The TVOCallInvite object represents an incoming Call Invite. TVOCallInvites are not created directly;
they are returned by the [TVONotificationDelegate callInviteReceived:] delegate method.
CallKit specific additions.
Properties
from
From value of the Call Invite.
@property (nonatomic, copy, readonly, nullable) NSString *fromDiscussion
This may be nil if the notification passed in [TwilioVoice handleNotification:delegate:]
method does not have valid information in it.
Declared In
TVOCallInvite.h
to
To value of the Call Invite.
@property (nonatomic, copy, readonly, nonnull) NSString *toDeclared In
TVOCallInvite.h
callSid
A server assigned identifier (SID) for the incoming Call.
@property (nonatomic, copy, readonly, nonnull) NSString *callSidDiscussion
Accepting a TVOCallInvite yields a TVOCall which inherits this SID.
See Also
TVOCall.sid
Declared In
TVOCallInvite.h
customParameters
Custom parameters embedded in the VoIP notification payload.
@property (nonatomic, strong, readonly, nullable) NSDictionary<NSString*NSString*> *customParametersDiscussion
The custom parameters will be received in the notification payload with the
twi_params key and in query-string format, e.g. key1=value1&key2=value2. To receive custom
parameters on the mobile client, add <Parameter> tags into the <Client> tag in the TwiML response.
<?xml version=“1.0” encoding=“UTF-8”?>
The customParameters value would be:
{ “caller_first_name” = “alice”; “caller_last_name” = “smith”; }
Note: While the value field passed into <Parameter> gets URI encoded by the Twilio infrastructure
and URI decoded when parsed during the creation of a TVOCallInvite, the name does not get URI encoded
or decoded. As a result, it is recommended that the name field only use ASCII characters.
Declared In
TVOCallInvite.h
Call Invite Actions
– acceptWithDelegate:
Accepts the incoming Call Invite.
- (nonnull TVOCall *)acceptWithDelegate:(nonnull id<TVOCallDelegate>)delegateParameters
delegate |
A |
|---|
Return Value
A TVOCall object.
See Also
Declared In
TVOCallInvite.h
– acceptWithOptions:delegate:
Accepts the incoming Call Invite.
- (nonnull TVOCall *)acceptWithOptions:(nonnull TVOAcceptOptions *)options delegate:(nonnull id<TVOCallDelegate>)delegateParameters
options |
An accept options. |
|---|---|
delegate |
A |
Return Value
A TVOCall object.
See Also
Declared In
TVOCallInvite.h
– init
Call Invites cannot be instantiated directly. See TVONotificationDelegate instead.
- (null_unspecified instancetype)initSee Also
Declared In
TVOCallInvite.h
CallKit Methods
uuid
UUID of the Call Invite.
@property (nonatomic, copy, readonly, nonnull) NSUUID *uuidDiscussion
Use this UUID for CallKit methods. Accepting a TVOCallInvite yields a TVOCall which inherits its
UUID from the Invite.
Declared In
TVOCallInvite.h