Quantum 3 3.1.0

Public Member Functions | Properties | List of all members
Photon.Realtime.FriendInfo Class Reference

Stores info about a friend's online state and in which room he/she is. More...

Public Member Functions

override string ToString ()
 Returns a string summarizing this FriendInfo. More...
 

Properties

bool IsInRoom [get]
 True if the friend is in a room. More...
 
bool IsOnline [get, protected set]
 True if the friend is online. More...
 
string Room [get, protected set]
 The name of the room this friend is currently in. Could be used for JoinRoom. Null otherwise. More...
 
string UserId [get, protected set]
 The UserId of the friend. Should be set and authenticated with Custom Authentication. More...
 

Detailed Description

Stores info about a friend's online state and in which room he/she is.

RealtimeClient.OpFindFriends

Member Function Documentation

◆ ToString()

override string Photon.Realtime.FriendInfo.ToString ( )
inline

Returns a string summarizing this FriendInfo.

Property Documentation

◆ UserId

string Photon.Realtime.FriendInfo.UserId
getprotected set

The UserId of the friend. Should be set and authenticated with Custom Authentication.

◆ IsOnline

bool Photon.Realtime.FriendInfo.IsOnline
getprotected set

True if the friend is online.

◆ Room

string Photon.Realtime.FriendInfo.Room
getprotected set

The name of the room this friend is currently in. Could be used for JoinRoom. Null otherwise.

◆ IsInRoom

bool Photon.Realtime.FriendInfo.IsInRoom
get

True if the friend is in a room.