Class SocialAttachment

Represents an image, document preview, or video preview attachment.

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_attachmentKind(): SocialAttachmentKind

Specifies the type of object that the attachment contains.

Returns

SocialAttachmentKind

public get_clickAction(): SocialAttachmentAction

Specifies the action to take when the user selects the attachment. This property is only present if the AttachmentKind is Video.

Returns

SocialAttachmentAction

public get_contentUri(): string

Specifies the URI of the attachment content.

Returns

string

public get_description(): string

Provides a text description of the attachment.

Returns

string

public get_height(): number

Specifies the height of the attachment or of the attachment preview.

Returns

number

public get_length(): number

Specifies the duration of the attachment in seconds. This property is only present if the AttachmentKind is Video.

Returns

number

public get_name(): string

Provides the attachment name.

Returns

string

public get_previewUri(): string

Specifies the URI of the attachment�s preview thumbnail. This property is only present if the AttachmentKind is Document or Video.

Returns

string

public get_typeId(): string

Returns

string

public get_uri(): string

Provides the attachment URI.

Returns

string

public get_width(): number

Specifies the width of the attachment or of the attachment preview.

Returns

number

public set_attachmentKind(value: SocialAttachmentKind): SocialAttachmentKind

Specifies the type of object that the attachment contains.

Parameters

Returns

SocialAttachmentKind

public set_clickAction(value: SocialAttachmentAction): SocialAttachmentAction

Specifies the action to take when the user selects the attachment. This property is only present if the AttachmentKind is Video.

Parameters

Returns

SocialAttachmentAction

public set_contentUri(value: string): string

Specifies the URI of the attachment content.

Parameters

  • value: string

Returns

string

public set_description(value: string): string

Provides a text description of the attachment.

Parameters

  • value: string

Returns

string

public set_height(value: number): number

Specifies the height of the attachment or of the attachment preview.

Parameters

  • value: number

Returns

number

public set_length(value: number): number

Specifies the duration of the attachment in seconds. This property is only present if the AttachmentKind is Video.

Parameters

  • value: number

Returns

number

public set_name(value: string): string

Provides the attachment name.

Parameters

  • value: string

Returns

string

public set_previewUri(value: string): string

Specifies the URI of the attachment�s preview thumbnail. This property is only present if the AttachmentKind is Document or Video.

Parameters

  • value: string

Returns

string

public set_uri(value: string): string

Provides the attachment URI.

Parameters

  • value: string

Returns

string

public set_width(value: number): number

Specifies the width of the attachment or of the attachment preview.

Parameters

  • value: number

Returns

number

public writeToXml(writer: XmlWriter, serializationContext: SerializationContext)

Parameters