FXmppUserJid Class Reference

#include <XmppConnection.h>

Public Member Functions
	FXmppUserJid (FString InId=FString(), FString InDomain=FString(), FString InResource=FString())
bool	ParseResource (FString &OutAppId, FString &OutPlatform, FString &OutPlatformUserId) const
bool	operator== (const FXmppUserJid &Other) const
bool	operator!= (const FXmppUserJid &Other) const
FString	GetFullPath () const
FString	GetBareId () const
bool	IsValid () const
XMPP_API FString	ToDebugString () const

Static Public Member Functions
static XMPP_API FXmppUserJid	FromFullJid (const FString &JidString)
static XMPP_API bool	ParseResource (const FString &InResource, FString &OutAppId, FString &OutPlatform, FString &OutPlatformUserId)
static XMPP_API FString	CreateResource (const FString &AppId, const FString &Platform, const FString &PlatformUserId)
static XMPP_API FString	ParseMucUserResource (const FString &InResource)

Public Attributes
FString	Id
FString	Domain
FString	Resource

Detailed Description

Jid for identifying user on the current connection as well as roster members

Constructor & Destructor Documentation

FXmppUserJid()

FXmppUserJid::FXmppUserJid ( FString  InId = FString(), FString  InDomain = FString(), FString  InResource = FString()  )

inlineexplicit

Member Function Documentation

CreateResource()

FString FXmppUserJid::CreateResource ( const FString &  AppId, const FString &  Platform, const FString &  PlatformUserId  )

static

FromFullJid()

FXmppUserJid FXmppUserJid::FromFullJid ( const FString &  JidString )

static

Create an FXmppUserJid from a formatted JID e.g., user@domain/resource

Parameters

JidString

the formatted JID

Returns

FXmppUserJid populated from the formatted JID

GetBareId()

FString FXmppUserJid::GetBareId ( ) const

inline

Return Bare id (id@domain)

GetFullPath()

FString FXmppUserJid::GetFullPath ( ) const

inline

full jid path <id@domain/resource>

IsValid()

bool FXmppUserJid::IsValid ( ) const

inline

Returns

true if jid has all valid elements

operator!=()

bool FXmppUserJid::operator!= ( const FXmppUserJid &  Other ) const

inline

operator==()

bool FXmppUserJid::operator== ( const FXmppUserJid &  Other ) const

inline

ParseMucUserResource()

FString FXmppUserJid::ParseMucUserResource ( const FString &  InResource )

static

Separate the MUC half of the resource (nickname:userid) from the UserJid resource portion (Vx:AppId:Platform:etc) This is highly dependent on FChatRoomMemberMcp::BuildMemberJidResourceString

ParseResource() [1/2]

bool FXmppUserJid::ParseResource ( const FString &  InResource, FString &  OutAppId, FString &  OutPlatform, FString &  OutPlatformUserId  )

static

Get the components that comprise the resource

Parameters

InResource	The resource to parse
OutAppId	The app id the user is using
OutPlatform	The platform the user is using
OutPlatformUserId	The platform user id (optional)

Returns

Whether the Resource was successfully parsed or not

ParseResource() [2/2]

bool FXmppUserJid::ParseResource ( FString &  OutAppId, FString &  OutPlatform, FString &  OutPlatformUserId  ) const

inline

Get the components that comprise the resource

Parameters

OutAppId	The app id the user is using
OutPlatform	The platform the user is using
OutPlatformUserId	The platform user id (optional)

Returns

Whether the Resource was successfully parsed or not

ToDebugString()

FString FXmppUserJid::ToDebugString

(

)

const

Member Data Documentation

Domain

FString FXmppUserJid::Domain

domain user has access to

Id

FString FXmppUserJid::Id

unique id for the user

Resource

FString FXmppUserJid::Resource

client resource user is logged in from

---

The documentation for this class was generated from the following files:

• Engine/Source/Runtime/Online/XMPP/Public/XmppConnection.h
• Engine/Source/Runtime/Online/XMPP/Private/XmppConnection.cpp