Class FollowedItem

Represents a followed content resource.

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_data(): { [name: string]: any; }

Additional metadata associated with this item

Returns

{ [name: string]: any; }

public get_fileType(): string

Specifies the type of the file if this item is a file. Otherwise, this property is the empty string.

Returns

string

public get_fileTypeProgid(): string

Provides information about the application that opens a followed document.

Returns

string

public get_flags(): string

Specifies additional information about the followed item. The server stores the data so that it can return it to the client.

Returns

string

public get_hasFeed(): boolean

Indicates whether the followed site has a feed.

Returns

boolean

public get_hidden(): boolean

Specifies if the item is hidden from the user. If true this item will not generate activity in the user's feed.

Returns

boolean

public get_iconUrl(): string

Specifies the URL of an icon to represent this item.

Returns

string

public get_itemId(): number

Specifies the identification for this item in the Content database.

Returns

number

public get_itemType(): FollowedItemType

Specifies the type of this item.

Returns

FollowedItemType

public get_listId(): string

The ListId property specifies the list identification (GUID) for this item in the Content database if this item is a list or the list identification for its parent list. If the ItemType is Document, this property is specified, but if the ItemType is Site, then this property is not specified.

Returns

string

public get_parentUrl(): string

Specifies the URL of this item's parent list or web.

Returns

string

public get_serverUrlProgid(): string

Provides information about the followed document to the application that opens it.

Returns

string

public get_siteId(): string

Specifies the site identification (GUID) in the Content database for this item if this item is a site, or for its parent site if this item is not a site.

Returns

string

public get_subtype(): number

Specifies the subtype of this item. If the ItemType is Site, the Subtype specifies the web template identification. If the ItemType is Document, the Subtype has a value of 1.

Returns

number

public get_title(): string

Specifies the item of this item

Returns

string

public get_typeId(): string

Returns

string

public get_uniqueId(): any

Specifies the GUID for this item in the Content database.

Returns

any

public get_url(): string

Specifies the URL of this item.

Returns

string

public get_webId(): string

Specifies the site identification (GUID) in the Content database for this item if it is a site, or the identification of its parent site if this item is a document.

Returns

string

public set_data(value: { [name: string]: any; }): { [name: string]: any; }

Additional metadata associated with this item

Parameters

  • value: { [name: string]: any; }

Returns

{ [name: string]: any; }

public set_fileType(value: string): string

Specifies the type of the file if this item is a file. Otherwise, this property is the empty string.

Parameters

  • value: string

Returns

string

public set_fileTypeProgid(value: string): string

Provides information about the application that opens a followed document.

Parameters

  • value: string

Returns

string

public set_flags(value: string): string

Specifies additional information about the followed item. The server stores the data so that it can return it to the client.

Parameters

  • value: string

Returns

string

public set_hasFeed(value: boolean): boolean

Indicates whether the followed site has a feed.

Parameters

  • value: boolean

Returns

boolean

public set_hidden(value: boolean): boolean

Specifies if the item is hidden from the user. If true this item will not generate activity in the user's feed.

Parameters

  • value: boolean

Returns

boolean

public set_iconUrl(value: string): string

Specifies the URL of an icon to represent this item.

Parameters

  • value: string

Returns

string

public set_itemId(value: number): number

Specifies the identification for this item in the Content database.

Parameters

  • value: number

Returns

number

public set_itemType(value: FollowedItemType): FollowedItemType

Specifies the type of this item.

Parameters

Returns

FollowedItemType

public set_listId(value: string): string

The ListId property specifies the list identification (GUID) for this item in the Content database if this item is a list or the list identification for its parent list. If the ItemType is Document, this property is specified, but if the ItemType is Site, then this property is not specified.

Parameters

  • value: string

Returns

string

public set_parentUrl(value: string): string

Specifies the URL of this item's parent list or web.

Parameters

  • value: string

Returns

string

public set_serverUrlProgid(value: string): string

Provides information about the followed document to the application that opens it.

Parameters

  • value: string

Returns

string

public set_siteId(value: string): string

Specifies the site identification (GUID) in the Content database for this item if this item is a site, or for its parent site if this item is not a site.

Parameters

  • value: string

Returns

string

public set_subtype(value: number): number

Specifies the subtype of this item. If the ItemType is Site, the Subtype specifies the web template identification. If the ItemType is Document, the Subtype has a value of 1.

Parameters

  • value: number

Returns

number

public set_title(value: string): string

Specifies the item of this item

Parameters

  • value: string

Returns

string

public set_uniqueId(value: any): any

Specifies the GUID for this item in the Content database.

Parameters

  • value: any

Returns

any

public set_url(value: string): string

Specifies the URL of this item.

Parameters

  • value: string

Returns

string

public set_webId(value: any): any

Specifies the site identification (GUID) in the Content database for this item if it is a site, or the identification of its parent site if this item is a document.

Parameters

  • value: any

Returns

any

public writeToXml(writer: XmlWriter, serializationContext: SerializationContext)

Parameters