Class Utility

public static createEmailBodyForInvitation(context: ClientRuntimeContext, pageAddress: string): StringResult

Parameters

• context: ClientRuntimeContext

• pageAddress: string

Returns

StringResult

public static createNewDiscussion(context: ClientRuntimeContext, list: List, title: string): ListItem

Parameters

• context: ClientRuntimeContext

• list: List

• title: string

Returns

ListItem

public static createNewDiscussionReply(context: ClientRuntimeContext, parent: ListItem): ListItem

Parameters

• context: ClientRuntimeContext

• parent: ListItem

Returns

ListItem

public static createWikiPageInContextWeb(context: ClientRuntimeContext, parameters: WikiPageCreationInformation): File

Parameters

• context: ClientRuntimeContext

• parameters: WikiPageCreationInformation

Returns

File

public static formatDateTime(context: ClientRuntimeContext, web: Web, datetime: Date, format: DateTimeFormat): StringResult

Parameters

• context: ClientRuntimeContext

• web: Web

• datetime: Date

• format: DateTimeFormat

Returns

StringResult

public static getAppLicenseDeploymentId(context: ClientRuntimeContext): GuidResult

Parameters

• context: ClientRuntimeContext

Returns

GuidResult

public static getAppLicenseInformation(context: ClientRuntimeContext, productId: Guid): AppLicenseCollection

Parameters

• context: ClientRuntimeContext

• productId: Guid

Returns

AppLicenseCollection

public static getCurrentUserEmailAddresses(context: ClientRuntimeContext): StringResult

Parameters

• context: ClientRuntimeContext

Returns

StringResult

public static getImageUrl(imageName: string): string

Parameters

• imageName: string

Returns

string

public static getLayoutsPageUrl(pageName: string): string

Parameters

• pageName: string

Returns

string

public static getLocalizedString(context: ClientRuntimeContext, source: string, defaultResourceFile: string, language: number): StringResult

Parameters

• context: ClientRuntimeContext

• source: string

• defaultResourceFile: string

• language: number

Returns

StringResult

public static getLowerCaseString(context: ClientRuntimeContext, sourceValue: string, lcid: number): StringResult

Parameters

• context: ClientRuntimeContext

• sourceValue: string

• lcid: number

Returns

StringResult

public static getPeoplePickerURL(context: ClientRuntimeContext, web: Web, fieldUser: FieldUser): StringResult

Parameters

• context: ClientRuntimeContext

• web: Web

• fieldUser: FieldUser

Returns

StringResult

public static get_layoutsLatestVersionRelativeUrl(): string

Returns

string

public static get_layoutsLatestVersionUrl(): string

Returns

string

public static importAppLicense(context: ClientRuntimeContext, licenseTokenToImport: string, contentMarket: string, billingMarket: string, appName: string, iconUrl: string, providerName: string, appSubtype: number)

Parameters

• context: ClientRuntimeContext

• licenseTokenToImport: string

• contentMarket: string

• billingMarket: string

• appName: string

• iconUrl: string

• providerName: string

• appSubtype: number

public static isUserLicensedForEntityInContext(context: ClientRuntimeContext, licensableEntity: string): BooleanResult

Parameters

• context: ClientRuntimeContext

• licensableEntity: string

Returns

BooleanResult

public static localizeWebPartGallery(context: ClientRuntimeContext, items: ListItemCollection): ClientObjectList

Parameters

• context: ClientRuntimeContext

• items: ListItemCollection

Returns

ClientObjectList

public static logCustomAppError(context: ClientRuntimeContext, error: string): IntResult

Parameters

• context: ClientRuntimeContext

• error: string

Returns

IntResult

public static logCustomRemoteAppError(context: ClientRuntimeContext, productId: Guid, error: string): IntResult

Parameters

• context: ClientRuntimeContext

• productId: Guid

• error: string

Returns

IntResult

public static markDiscussionAsFeatured(context: ClientRuntimeContext, listID: string, topicIDs: string)

Parameters

• context: ClientRuntimeContext

• listID: string

• topicIDs: string

public static resolvePrincipal(context: ClientRuntimeContext, web: Web, input: string, scopes: PrincipalType, sources: PrincipalSource, usersContainer: UserCollection, inputIsEmailOnly: boolean): PrincipalInfo

Parameters

• context: ClientRuntimeContext

• web: Web

• input: string

• scopes: PrincipalType

• sources: PrincipalSource

• usersContainer: UserCollection

• inputIsEmailOnly: boolean

Returns

PrincipalInfo

public static searchPrincipals(context: ClientRuntimeContext, web: Web, input: string, scopes: PrincipalType, sources: PrincipalSource, usersContainer: UserCollection, maxCount: number): PrincipalInfo[]

Parameters

• context: ClientRuntimeContext

• web: Web

• input: string

• scopes: PrincipalType

• sources: PrincipalSource

• usersContainer: UserCollection

• maxCount: number

Returns

PrincipalInfo[]

public static unmarkDiscussionAsFeatured(context: ClientRuntimeContext, listID: string, topicIDs: string)

Parameters

• context: ClientRuntimeContext

• listID: string

• topicIDs: string