Class SocialActor

Contains information about an actor retrieved from server. An actor is a user, document, site, or tag.

Hierarchy

Index

Methods

Methods

public customFromJson(obj: any): boolean

Parameters

  • obj: any

Returns

boolean

public customWriteToXml(writer: XmlWriter, serializationContext: SerializationContext): boolean

Parameters

Returns

boolean

public fromJson(obj: any)

Parameters

  • obj: any

public get_accountName(): string

The AccountName property returns the user account name. This property is only available for social actors of type "user".

Returns

string

public get_actorType(): SocialActorType

Identifies whether the actor is a user, document, site, or tag.

Returns

SocialActorType

public get_canFollow(): boolean

Specifies whether the actor can be followed by the current user.

Returns

boolean

public get_contentUri(): string

Returns the URI of the document or site content. This property is only available for social actors of type Document or Site.

Returns

string

public get_emailAddress(): string

Returns

string

public get_followedContentUri(): string

Returns the URI of the user's followed content folder. This property is only available for social actors of type "user".

Returns

string

public get_id(): string

Returns the actor's unique identifier.

Returns

string

public get_imageUri(): string

Returns the URI of the image representing the actor. This property is only available if actor is User, Document, or Site.

Returns

string

public get_isFollowed(): boolean

Returns true if the current user is following the actor; otherwise, it returns false.

Returns

boolean

public get_libraryUri(): string

Returns the URI of the library containing the document. This property is only available for social actors of type "document".

Returns

string

public get_name(): string

The Name property returns the actor's display name.

Returns

string

public get_personalSiteUri(): string

Returns the URI of the user's personal site. This property is only available for social actors of type "user".

Returns

string

public get_status(): SocialStatusCode

Represents the status of retrieving the actor

Returns

SocialStatusCode

public get_statusText(): string

The StatusText property returns the most recent post of the user. This property is only available for social actors of type "user".

Returns

string

public get_tagGuid(): string

Returns the GUID of the tag. Only available for social actors of type "tag"

Returns

string

public get_title(): string

Returns the user's title This property is only available for social actors of type "user".

Returns

string

public get_typeId(): string

Returns

string

public get_uri(): string

Returns the URI of the actor.

Returns

string

public writeToXml(writer: XmlWriter, serializationContext: SerializationContext)

Parameters