Class PeopleManager

Provides methods for operations related to people. Note: The SocialFollowingManager object is the recommended object for performing Following People and Following Content tasks. However, PeopleManager provides some methods that SocialFollowingManager doesn�t.

Hierarchy

Index

Constructor methods

Methods

Constructor methods

constructor(context: ClientRuntimeContext): PeopleManager

Parameters

Returns

PeopleManager

Methods

public amIFollowedBy(accountName: string): BooleanResult

Parameters

  • accountName: string

Returns

BooleanResult

public amIFollowing(accountName: string): BooleanResult

Parameters

  • accountName: string

Returns

BooleanResult

public customFromJson(initValue: any): boolean

Parameters

  • initValue: any

Returns

boolean

public follow(accountName: string)

Parameters

  • accountName: string

public followTag(tagId: string)

Add the specified tag to the current user's list of followed tags.

Parameters

  • tagId: string

    GUID of the tag to start following.

public fromJson(initValue: any)

Parameters

  • initValue: any

public getFollowedTags(numberOfTagsToFetch: number): Array<string>

Gets tags that the user is following.

Parameters

  • numberOfTagsToFetch: number

Returns

Array<string>

public getFollowersFor(accountName: string): ClientObjectList

Parameters

  • accountName: string

Returns

ClientObjectList

public getMyFollowers(): ClientObjectList

Returns

ClientObjectList

public getMyProperties(): PersonProperties

Gets user properties for the current user.

Returns

PersonProperties

public getMySuggestions(): ClientObjectList

Gets suggestions for who the current user might want to follow. Note: The recommended API to use for this task is SocialFollowingManager.getSuggestions. Returns list of PersonProperties objects

Returns

ClientObjectList

public getPeopleFollowedBy(accountName: string): ClientObjectList

Parameters

  • accountName: string

Returns

ClientObjectList

public getPeopleFollowedByMe(): ClientObjectList

Returns

ClientObjectList

public getPropertiesFor(accountName: string): PersonProperties

Parameters

  • accountName: string

Returns

PersonProperties

public static getTrendingTags(context: ClientRuntimeContext): HashTagCollection

Parameters

Returns

HashTagCollection

public getUserProfilePropertiesFor(propertiesForUser: UserProfilePropertiesForUser): Array<any>

Gets the specified user profile properties for the specified user.

Parameters

Returns

Array<any>

public getUserProfilePropertyFor(accountName: string, propertyName: string): string

Gets the specified user profile property for the specified user.

Parameters

  • accountName: string
  • propertyName: string

Returns

string

public get_context(): ClientRuntimeContext

Returns

ClientRuntimeContext

public get_editProfileLink(): string

Gets the URL of the edit profile page for the current user.

Returns

string

public get_isMyPeopleListPublic(): boolean

Gets a Boolean value that indicates whether the current user's People I'm Following list is public.

Returns

boolean

public get_objectVersion(): string

Returns

string

public get_path(): ObjectPath

Returns

ObjectPath

public get_serverObjectIsNull(): boolean

Returns

boolean

public get_typedObject(): ClientObject

Returns

ClientObject

public hideSuggestion(accountName: string)

Removes the specified user from the user's list of suggested people to follow.

Parameters

  • accountName: string

public static isFollowing(context: ClientRuntimeContext, possibleFollowerAccountName: string, possibleFolloweeAccountName: string): BooleanResult

Checks whether the first user is following the second user.

Parameters

  • context: ClientRuntimeContext
  • possibleFollowerAccountName: string
  • possibleFolloweeAccountName: string

Returns

BooleanResult

public isObjectPropertyInstantiated(propertyName: string): boolean

Parameters

  • propertyName: string

Returns

boolean

public isPropertyAvailable(propertyName: string): boolean

Parameters

  • propertyName: string

Returns

boolean

public refreshLoad()

public retrieve()

public retrieve(propertyNames: Array<string>)

Parameters

  • propertyNames: Array<string>

public setMyProfilePicture(data: any)

Uploads and sets the user profile picture. Pictures in bmp, jpg and png formats and up to 5,000,000 bytes are supported. A user can upload a picture only to the user's own profile.

Parameters

  • data: any

    Binary content of an image file

public set_objectVersion(value: string)

Parameters

  • value: string

public stopFollowing(accountName: string)

Parameters

  • accountName: string

public stopFollowingTag(tagId: string)

Remove the specified tag from the current user's list of followed tags.

Parameters

  • tagId: string

    GUID of the tag to stop following.