TVOConnectOptions Class Reference

Inherits from TVOCallOptions : NSObject
Declared in TVOConnectOptions.h

Overview

Connect options builder to use when connecting. For example:

 let connectOptions = TVOConnectOptions(accessToken: accessToken) { builder in
     builder.params = ["to": "bob"]
     builder.enableIceGatheringOnAnyAddressPorts = true
 }

 let call = TwilioVoice.connect(with: connectOptions, delegate: callDelegate)

  accessToken

A JWT access token which will be used to connect a Call.

@property (nonatomic, copy, readonly, nullable) NSString *accessToken

Declared In

TVOConnectOptions.h

  params

The parameters passed to the server application associated with this Call.

@property (nonatomic, copy, readonly, nonnull) NSDictionary<NSString*NSString*> *params

Declared In

TVOConnectOptions.h

– init

Developers shouldn’t initialize this class directly.

- (null_unspecified instancetype)init

Discussion

Use the class methods optionsWithToken: or optionsWithToken:block: instead.

Declared In

TVOConnectOptions.h

+ optionsWithAccessToken:

Creates TVOConnectOptions using an access token.

+ (nonnull instancetype)optionsWithAccessToken:(nonnull NSString *)accessToken

Parameters

accessToken

A JWT access token which will be used to connect to the Call.

Return Value

An instance of TVOConnectOptions.

Discussion

The maximum number of characters for the identity provided in the token is 121. The identity may only contain alpha-numeric and underscore characters. Other characters, including spaces, or exceeding the maximum number of characters, will result in not being able to place or receive calls.

Declared In

TVOConnectOptions.h

+ optionsWithAccessToken:block:

Creates an instance of TVOConnectOptions using an access token and a builder block.

+ (nonnull instancetype)optionsWithAccessToken:(nonnull NSString *)accessToken block:(nonnull TVOConnectOptionsBuilderBlock)block

Parameters

accessToken

A JWT access token which will be used to connect to the Call.
block

The builder block which will be used to configure the TVOConnectOptions instance.

Return Value

An instance of TVOConnectOptions.

Discussion

The maximum number of characters for the identity provided in the token is 121. The identity may only contain alpha-numeric and underscore characters. Other characters, including spaces, or exceeding the maximum number of characters, will result in not being able to place or receive calls.

Declared In

TVOConnectOptions.h