Class TransferAction

Namespace

Vonage.Voice.Nccos

Assembly

Vonage.dll

Moves the call legs from a current conversation into another existing conversation.

public class TransferAction : NccoAction

Inheritance

object

NccoAction

TransferAction

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

TransferAction(string)

Moves the call legs from a current conversation into another existing conversation.

public TransferAction(string conversationId)

Parameters

conversationId string

Target conversation ID, defined as string.

Properties

Action

The type of NCCO action to execute.

public override NccoAction.ActionType Action { get; }

Property Value

NccoAction.ActionType

CanHear

A list of leg UUIDs that this participant can hear, defined as an array of strings. If not provided, the participant can hear everyone. If an empty list is provided, the participant will not hear any other participants.

[JsonProperty("canHear", Order = 2)]
public IEnumerable<string> CanHear { get; }

Property Value

IEnumerable<string>

CanSpeak

A list of leg UUIDs that this participant can be heard by, defined as an array of strings. If not provided, the participant can be heard by everyone. If an empty list is provided, the participant will not be heard by anyone.

[JsonProperty("canSpeak", Order = 3)]
public IEnumerable<string> CanSpeak { get; }

Property Value

IEnumerable<string>

ConversationId

Target conversation ID, defined as string.

[JsonProperty("conversationId", Order = 1)]
public string ConversationId { get; }

Property Value

string

Muted

Set to true to mute the participant. The audio from the participant will not be played to the conversation and will not be recorded. When using canSpeak, the mute parameter is not supported.

[JsonProperty("mute", Order = 4)]
public bool Muted { get; }

Property Value

bool

Methods

CanHearNoParticipants()

The participant will not hear any other participants.

public TransferAction CanHearNoParticipants()

Returns

TransferAction

The transfer action.

CanHearParticipant(string)

Adds a specific participant that this participant can hear.

public TransferAction CanHearParticipant(string legId)

Parameters

legId string

The leg UUID.

Returns

TransferAction

The transfer action.

CanSpeakToNoParticipants()

The participant will not be heard by any other participants.

public TransferAction CanSpeakToNoParticipants()

Returns

TransferAction

The transfer action.

CanSpeakToParticipant(string)

Adds a specific participant that this participant can speak to.

public TransferAction CanSpeakToParticipant(string legId)

Parameters

legId string

The leg UUID.

Returns

TransferAction

The transfer action.

Mute()

Mute the participant.

public TransferAction Mute()

Returns

TransferAction

The transfer action.