Interface IProfile

Interface representing a social media profile.

Namespace: SociallyDistant.Core.Social
Assembly: SociallyDistant.Framework.dll
Syntax
public interface IProfile

Properties

Attributes

Gets a CharacterAttributes value indicating how this profile should be treated in the UI.

Declaration
CharacterAttributes Attributes { get; }
Property Value
Type Description
CharacterAttributes

Bio

Gets a string of text displayed in this profile's "About Me" section in the UI.

Declaration
string Bio { get; }
Property Value
Type Description
string

ChatName

Gets the user's display name.

Declaration
string ChatName { get; }
Property Value
Type Description
string

ChatUsername

Gets the user's chat username. This value is also used as the user's email address, without a domain suffix.

Declaration
string ChatUsername { get; }
Property Value
Type Description
string

Gender

Gets a Gender value indicating this profile's gender identity and preferred pronouns.

Declaration
Gender Gender { get; }
Property Value
Type Description
Gender

IsPrivate

Gets a value indicating whether this profile's privacy settings restrict viewing of social posts by non-followers.

Declaration
bool IsPrivate { get; }
Property Value
Type Description
bool

Picture

Gets an optional Microsoft.Xna.Framework.Graphics.Texture2D instance for the user's profile picture. If null, a default profile picture should be rendered instead.

Declaration
Texture2D? Picture { get; }
Property Value
Type Description
Texture2D

ProfileId

Gets the unique world object ID of this profile.

Declaration
ObjectId ProfileId { get; }
Property Value
Type Description
ObjectId
See Also

SocialHandle

Gets the social username (@handle) of this profile.

Declaration
string SocialHandle { get; }
Property Value
Type Description
string

Methods

IsBlockedBy(IProfile)

Checks if this user is blocked by the given user.

Declaration
bool IsBlockedBy(IProfile user)
Parameters
Type Name Description
IProfile user

The user whose block list to check.
Returns
Type Description
bool

True if this user is blocked.

IsFriendsWith(IProfile)

Determines whether this user is friends with the given user.

Declaration
bool IsFriendsWith(IProfile friend)
Parameters
Type Name Description
IProfile friend

The other user to check friendship status of.
Returns
Type Description
bool

True if the two profiles are friends.