Documentation

Support

Vivox Unreal SDK

Vivox Unreal SDK

Directed text

Learn how to send and receive direct text messages to other users.
Read time 1 minuteLast updated 2 days ago
Vivox provides directed text by using a similar process to what is used for group text. You can add players to existing text sessions, and you can send text messages directly to any user who is signed in, independent of being in a channel with them. Use directed text for short user-to-user messages (sometimes called whispers or private/direct messages), or to implement invite to channel capabilities. To send a text message to another user, use the 
ILoginSession::BeginSendDirectedMessage
method. The following code displays an example of this process: 
/* . . . */AccountId Target = AccountId(kDefaultIssuer, "example_target", kDefaultDomain);FString Message = TEXT("Example private message.");ILoginSession::FOnBeginSendDirectedMessageCompletedDelegate SendDirectedMessageCallback;SendDirectedMessageCallback.BindLambda([this, Target, Message](VivoxCoreError Error){    if(VxErrorSuccess == Error)    {        UE_LOG(MyLog, Log, TEXT("Message sent to %s: %s\n"), *Target.Name(), *Message);    }});MyLoginSession.BeginSendDirectedMessage(Target, Message, SendDirectedMessageCallback);/* . . . */
The 
ILoginSession::EventDirectedTextMessageReceived
event is sent to the game when a user-to-user text message is available. The following code is an example of this action: 
void UMyGameClass::OnDirectedTextMessageReceived(const IDirectedTextMessage &Message){    UE_LOG(MyLog, Log, TEXT("Message from %s: %s\n"), *Message.Sender().Name(), *Message.Message());}