TVOCall Class Reference

Inherits from NSObject
Declared in TVOCall.h

Overview

The TVOCall object represents a call. TVOCall objects are not created directly; they are returned by the [TVOCallInvite acceptWithDelegate:] method or the [Voice call:params:delegate:] method.

CallKit Call Actions

Properties

  delegate

The TVOCallDelegate object that will receive call state updates.

@property (nonatomic, weak, nullable) id<TVOCallDelegate> delegate

Discussion

The TVOCallDelegate object that will receive call state updates.

See Also

Declared In

TVOCall.h

  from

From value of the call. Note: This may be nil if the call object was created by calling the [Voice call:params:delegate:] method.

@property (nonatomic, strong, readonly, nonnull) NSString *from

Discussion

From value of the call. Note: This may be nil if the call object was created by calling the [Voice call:params:delegate:] method.

Declared In

TVOCall.h

  to

To value of the call. Note: This may be nil if the call object was created by calling the [Voice call:params:delegate:] method.

@property (nonatomic, strong, readonly, nonnull) NSString *to

Discussion

To value of the call. Note: This may be nil if the call object was created by calling the [Voice call:params:delegate:] method.

Declared In

TVOCall.h

  callSid

Call SID value of the call.

@property (nonatomic, strong, readonly, nonnull) NSString *callSid

Discussion

Call SID value of the call.

Declared In

TVOCall.h

  muted

Property that defines if the call is muted.

@property (nonatomic, assign, getter=isMuted) BOOL muted

Discussion

Property that defines if the call is muted.

Setting the property will only take effect if the state is TVOCallConnected.

Declared In

TVOCall.h

  state

State of the call.

@property (nonatomic, assign, readonly) TVOCallState state

Discussion

State of the call.

See Also

Declared In

TVOCall.h

General Call Actions

– disconnect

Disconnects the call.

- (void)disconnect

Discussion

Disconnects the call.

Calling this method on a TVOCall that does not have the state of TVOCallStateConnected will have no effect.

Declared In

TVOCall.h

– sendDigits:

Send a string of digits.

- (void)sendDigits:(nonnull NSString *)digits

Parameters

digits

A string of characters to be played. Valid values are ‘0’ - ‘9’, ‘*’, ‘#’, and ‘w’. Each ‘w’ will cause a 500 ms pause between digits sent.

Discussion

Send a string of digits.

Calling this method on a TVOCall that does not have the state of TVOCallStateConnected will have no effect.

Declared In

TVOCall.h

CallKitIntegration Methods

  uuid

UUID of the call.

@property (nonatomic, strong, nonnull) NSUUID *uuid

Discussion

UUID of the call.

Use this UUID for CallKit methods.

Declared In

TVOCall.h