Class SocialDataOverlay

Provides information about an overlay. An overlay is a substring in a post that represents a user, document, site, tag, or link. The SocialPost class contains an array of SocialDataOverlay objects. Each of the SocialDataOverlay objects specifies a link or one or more actors.

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_actorIndexes(): Array<number>

Specifies one or more actors as an array of integers where each integer specifies an index into the SocialThreadActors array. This property is only available if the get_overlayType() has a value of SocialDataOverlayType.actors.

Returns

Array<number>

public get_index(): number

The Index property specifies the starting position of the overlay in the SocialPostText string

Returns

number

public get_length(): number

The Length property specifies the number of characters in the overlay.

Returns

number

public get_linkUri(): string

The LinkUri property specifies the URI of the link. This property is only available if the get_overlayType() has a value of SocialDataOverlayType.link.

Returns

string

public get_overlayType(): SocialDataOverlayType

Specifies whether the overlay is a link or one or more actors.

Returns

SocialDataOverlayType

public get_typeId(): string

Returns

string

public writeToXml(writer: XmlWriter, serializationContext: SerializationContext)

Parameters