Package com.vonage.client.conversations

Class Member.Builder

java.lang.Object

com.vonage.client.conversations.Member.Builder

Enclosing class:

Member

public static class Member.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
Member	build()	Builds the Member.
Member.Builder	channelType(ChannelType channelType)	(REQUIRED) Top-level channel type.
Member.Builder	from(String from)	(OPTIONAL) TODO document this
Member.Builder	fromChannel(Channel from)	(OPTIONAL) Concrete channel to use when sending messages.
Member.Builder	knockingId(String knockingId)	(OPTIONAL) Unique knocking identifier.
Member.Builder	media(MemberMedia media)	(OPTIONAL) Media settings for this member.
Member.Builder	memberIdInviting(String memberIdInviting)	(OPTIONAL) Unique member ID to invite.
Member.Builder	state(MemberState state)	(REQUIRED) Invite or join a member to a conversation.
Member.Builder	toChannel(Channel to)	(OPTIONAL) Concrete channel to use when receiving messages.
Member.Builder	user(String userNameOrId)	(REQUIRED) Either the user ID or unique name is required.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

user

public Member.Builder user(String userNameOrId)

(REQUIRED) Either the user ID or unique name is required. This method will automatically determine which is provided. User IDs start with USR- followed by a UUID.

Parameters:

userNameOrId - Either the unique user ID, or the name.

Returns:

This builder.

state

public Member.Builder state(MemberState state)

(REQUIRED) Invite or join a member to a conversation.

Parameters:

state - The state as an enum.

Returns:

This builder.

channelType

public Member.Builder channelType(ChannelType channelType)

(REQUIRED) Top-level channel type. You should also provide fromChannel(Channel) and toChannel(Channel). If this is set to anything other than ChannelType.APP, then both fromChannel(Channel) and toChannel(Channel) must be of the same type as each other.

Parameters:

channelType - The channel type as an enum.

Returns:

This builder.

fromChannel

public Member.Builder fromChannel(Channel from)

(OPTIONAL) Concrete channel to use when sending messages. See com.vonage.client.users.channels for options.

Parameters:

from - The sender channel.

Returns:

This builder.

See Also:

• channelType(ChannelType)

toChannel

public Member.Builder toChannel(Channel to)

(OPTIONAL) Concrete channel to use when receiving messages. See com.vonage.client.users.channels for options.

Parameters:

to - The receiver channel.

Returns:

This builder.

See Also:

• channelType(ChannelType)

media

public Member.Builder media(MemberMedia media)

(OPTIONAL) Media settings for this member.

Parameters:

media - The media settings object.

Returns:

This builder.

knockingId

public Member.Builder knockingId(String knockingId)

(OPTIONAL) Unique knocking identifier.

Parameters:

knockingId - The knocking ID as a string.

Returns:

This builder.

memberIdInviting

public Member.Builder memberIdInviting(String memberIdInviting)

(OPTIONAL) Unique member ID to invite.

Parameters:

memberIdInviting - The inviting member ID, or null if unspecified.

Returns:

This builder.

from

public Member.Builder from(String from)

(OPTIONAL) TODO document this

Parameters:

from - The from field.

Returns:

This builder.

build

public Member build()

Builds the Member.

Returns:

An instance of Member, populated with all fields from this builder.