diff --git a/sharepoint/SharePoint-tests.ts b/sharepoint/SharePoint-tests.ts new file mode 100644 index 0000000000..83934008c5 --- /dev/null +++ b/sharepoint/SharePoint-tests.ts @@ -0,0 +1,525 @@ +/// + +// Website tasks +function retrieveWebsite(resultpanel:HTMLElement) { + var clientContext = SP.ClientContext.get_current(); + var oWebsite = clientContext.get_web(); + clientContext.load(oWebsite); + + clientContext.executeQueryAsync( + successHandler, + errorHandler + ); + + function successHandler() { + resultpanel.innerHTML = "Web site title: " + oWebsite.get_title(); + } + + function errorHandler() { + resultpanel.innerHTML = "Request failed: " + arguments[1].get_message(); + } +} + +function retrieveWebsiteProps(resultpanel: HTMLElement) { + + var clientContext = SP.ClientContext.get_current(); + var oWebsite = clientContext.get_web(); + + clientContext.load(oWebsite, "Description", "Created"); + + clientContext.executeQueryAsync(successHandler,errorHandler); + + function successHandler() { + resultpanel.innerHTML = "Description: " + oWebsite.get_description() + + "
Date created: " + oWebsite.get_created(); + } + + function errorHandler() { + resultpanel.innerHTML = "Request failed: " + arguments[1].get_message(); + } +} + +function writeWebsiteProps(resultpanel: HTMLElement) { + + var clientContext = SP.ClientContext.get_current(); + var oWebsite = clientContext.get_web(); + + oWebsite.set_description("This is an updated description."); + oWebsite.update(); + + clientContext.load(oWebsite, "Description"); + + clientContext.executeQueryAsync( + successHandler, + errorHandler + ); + + + function successHandler() { + resultpanel.innerHTML = "Web site description: " + oWebsite.get_description(); + } + + function errorHandler() { + resultpanel.innerHTML = "Request failed: " + arguments[1].get_message(); + } +} + +// Lists tasks +function readAllProps(resultpanel: HTMLElement) { + + var clientContext = SP.ClientContext.get_current(); + var oWebsite = clientContext.get_web(); + + var collList = oWebsite.get_lists(); + clientContext.load(collList); + + clientContext.executeQueryAsync( + successHandler, + errorHandler + ); + + function successHandler() { + + var listEnumerator = collList.getEnumerator(); + + var listInfo = ""; + while (listEnumerator.moveNext()) { + var oList = listEnumerator.get_current(); + listInfo += "Title: " + oList.get_title() + " Created: " + + oList.get_created().toString() + "
"; + } + + resultpanel.innerHTML = listInfo; + } + + function errorHandler() { + resultpanel.innerHTML = "Request failed: " + arguments[1].get_message(); + } +} + +function readSpecificProps(resultpanel: HTMLElement) { + + var clientContext = SP.ClientContext.get_current(); + var oWebsite = clientContext.get_web(); + + var collList = oWebsite.get_lists(); + + clientContext.load(collList, "Include(Title, Id)"); + + clientContext.executeQueryAsync( + successHandler, + errorHandler + ); + + function successHandler() { + + var listEnumerator = collList.getEnumerator(); + + var listInfo = ""; + while (listEnumerator.moveNext()) { + var oList = listEnumerator.get_current(); + listInfo += "Title: " + oList.get_title() + + " ID: " + oList.get_id().toString() + "
"; + } + + resultpanel.innerHTML = listInfo; + } + + function errorHandler() { + resultpanel.innerHTML = "Request failed: " + arguments[1].get_message(); + } +} + +function readColl(resultpanel: HTMLElement) { + + var clientContext = SP.ClientContext.get_current(); + var oWebsite = clientContext.get_web(); + var collList = oWebsite.get_lists(); + + var listInfoCollection = clientContext.loadQuery(collList, "Include(Title, Id)"); + + clientContext.executeQueryAsync( + successHandler, + errorHandler + ); + + function successHandler() { + var listInfo = ""; + for (var i = 0; i < listInfoCollection.length; i++) { + var oList = listInfoCollection[i]; + listInfo += "Title: " + oList.get_title() + + " ID: " + oList.get_id().toString() + "
"; + } + + resultpanel.innerHTML = listInfo; + } + + function errorHandler() { + resultpanel.innerHTML = "Request failed: " + arguments[1].get_message(); + } +} + +function readFilter(resultpanel: HTMLElement) { + var clientContext = SP.ClientContext.get_current(); + var oWebsite = clientContext.get_web(); + var collList = oWebsite.get_lists(); + + var listInfoArray = clientContext.loadQuery(collList, + "Include(Title,Fields.Include(Title,InternalName))"); + + clientContext.executeQueryAsync( + successHandler, + errorHandler + ); + + function successHandler() { + + for (var i = 0; i < listInfoArray.length; i++) { + var oList = listInfoArray[i]; + var collField = oList.get_fields(); + var fieldEnumerator = collField.getEnumerator(); + + var listInfo = ""; + while (fieldEnumerator.moveNext()) { + var oField = fieldEnumerator.get_current(); + var regEx = new RegExp("name", "ig"); + + if (regEx.test(oField.get_internalName())) { + listInfo += "List: " + oList.get_title() + + "
    Field Title: " + oField.get_title() + + "
    Field Internal name: " + oField.get_internalName(); + } + } + } + + resultpanel.innerHTML = listInfo; + } + + function errorHandler() { + resultpanel.innerHTML = "Request failed: " + arguments[1].get_message(); + } +} + +// Create, update and delete lists +function createList(resultpanel: HTMLElement) { + + var clientContext = SP.ClientContext.get_current(); + var oWebsite = clientContext.get_web(); + + var listCreationInfo = new SP.ListCreationInformation(); + listCreationInfo.set_title("My Announcements List"); + listCreationInfo.set_templateType(SP.ListTemplateType.announcements); + + var oList = oWebsite.get_lists().add(listCreationInfo); + clientContext.load(oList); + + clientContext.executeQueryAsync( + successHandler, + errorHandler + ); + + function successHandler() { + resultpanel.innerHTML = "Go to the list."; + } + + function errorHandler() { + resultpanel.innerHTML = "Request failed: " + arguments[1].get_message(); + } +} + +function updateList(resultpanel: HTMLElement) { + + var clientContext = SP.ClientContext.get_current(); + var oWebsite = clientContext.get_web(); + + var oList = oWebsite.get_lists().getByTitle("My Announcements List"); + oList.set_description("New Announcements List"); + oList.update(); + + clientContext.load(oList); + clientContext.executeQueryAsync( + successHandler, + errorHandler + ); + + function successHandler() { + resultpanel.innerHTML = "Check the description in the list."; + } + + function errorHandler() { + resultpanel.innerHTML = "Request failed: " + arguments[1].get_message(); + } +} + +function addField(resultpanel: HTMLElement) { + + var clientContext = SP.ClientContext.get_current(); + var oWebsite = clientContext.get_web(); + var oList = oWebsite.get_lists().getByTitle("My Announcements List"); + + var oField = oList.get_fields().addFieldAsXml( + "", + true, + SP.AddFieldOptions.defaultValue + ); + + var fieldNumber = clientContext.castTo(oField, SP.FieldNumber); + fieldNumber.set_maximumValue(100); + fieldNumber.set_minimumValue(35); + fieldNumber.update(); + + clientContext.load(oField); + + clientContext.executeQueryAsync( + successHandler, + errorHandler + ); + + function successHandler() { + resultpanel.innerHTML = "The list with a new field."; + } + + function errorHandler() { + resultpanel.innerHTML = "Request failed: " + arguments[1].get_message(); + } +} + +function deleteList(resultpanel: HTMLElement) { + var listTitle = "My Announcements List"; + + var clientContext = SP.ClientContext.get_current(); + var oWebsite = clientContext.get_web(); + var oList = oWebsite.get_lists().getByTitle(listTitle); + oList.deleteObject(); + + clientContext.executeQueryAsync( + successHandler, + errorHandler + ); + + function successHandler() { + resultpanel.innerHTML = listTitle + " deleted."; + } + + function errorHandler() { + resultpanel.innerHTML = "Request failed: " + arguments[1].get_message(); + } +} + +// Create, update and delete folders +function createFolder(resultpanel: HTMLElement) { + var clientContext = SP.ClientContext.get_current(); + var oWebsite = clientContext.get_web(); + var oList = oWebsite.get_lists().getByTitle("Shared Documents"); + + var itemCreateInfo = new SP.ListItemCreationInformation(); + itemCreateInfo.set_underlyingObjectType(SP.FileSystemObjectType.folder); + itemCreateInfo.set_leafName("My new folder!"); + var oListItem = oList.addItem(itemCreateInfo); + oListItem.update(); + + clientContext.load(oListItem); + clientContext.executeQueryAsync( + successHandler, + errorHandler + ); + + function successHandler() { + resultpanel.innerHTML = "Go to the document library to see your new folder."; + } + + function errorHandler() { + resultpanel.innerHTML = "Request failed: " + arguments[1].get_message(); + } +} + +function updateFolder(resultpanel: HTMLElement) { + var clientContext = SP.ClientContext.get_current(); + var oWebsite = clientContext.get_web(); + var oList = oWebsite.get_lists().getByTitle("Shared Documents"); + + var oListItem = oList.getItemById(1); + oListItem.set_item("FileLeafRef", "My updated folder"); + oListItem.update(); + + clientContext.load(oListItem); + clientContext.executeQueryAsync( + successHandler, + errorHandler + ); + + function successHandler() { + resultpanel.innerHTML = "Go to the document library to see your updated folder."; + } + + function errorHandler() { + resultpanel.innerHTML = "Request failed: " + arguments[1].get_message(); + } +} + +function deleteFolder(resultpanel: HTMLElement) { + var clientContext = SP.ClientContext.get_current(); + var oWebsite = clientContext.get_web(); + var oList = oWebsite.get_lists().getByTitle("Shared Documents"); + + var oListItem = oList.getItemById(1); + oListItem.deleteObject(); + + clientContext.executeQueryAsync( + successHandler, + errorHandler + ); + + function successHandler() { + resultpanel.innerHTML = "Go to the document library to make sure the folder is no longer there."; + } + + function errorHandler() { + resultpanel.innerHTML = "Request failed: " + arguments[1].get_message(); + } +} + +// List item tasks +function readItems(resultpanel: HTMLElement) { + var clientContext = SP.ClientContext.get_current(); + var oWebsite = clientContext.get_web(); + var oList = oWebsite.get_lists().getByTitle("Announcements"); + var camlQuery = new SP.CamlQuery(); + camlQuery.set_viewXml( + '' + + '1' + + '10' + ); + var collListItem = oList.getItems(camlQuery); + + clientContext.load(collListItem); + clientContext.executeQueryAsync( + successHandler, + errorHandler + ); + + function successHandler() { + var listItemEnumerator = collListItem.getEnumerator(); + + var listItemInfo = ""; + while (listItemEnumerator.moveNext()) { + var oListItem = listItemEnumerator.get_current(); + listItemInfo += "ID: " + oListItem.get_id() + "
" + + "Title: " + oListItem.get_item("Title") + "
" + + "Body: " + oListItem.get_item("Body") + "
"; + } + + resultpanel.innerHTML = listItemInfo; + } + + function errorHandler() { + resultpanel.innerHTML = "Request failed: " + arguments[1].get_message(); + } +} + +function readInclude(resultpanel: HTMLElement) { + var clientContext = SP.ClientContext.get_current(); + var oWebsite = clientContext.get_web(); + var oList = oWebsite.get_lists().getByTitle("Announcements"); + var camlQuery = new SP.CamlQuery(); + camlQuery.set_viewXml('100'); + + var collListItem = oList.getItems(camlQuery); + + clientContext.load(collListItem, "Include(Id, DisplayName, HasUniqueRoleAssignments)"); + clientContext.executeQueryAsync( + successHandler, + errorHandler + ); + + function successHandler() { + var listItemEnumerator = collListItem.getEnumerator(); + + var listItemInfo = ""; + while (listItemEnumerator.moveNext()) { + var oListItem = listItemEnumerator.get_current(); + listItemInfo += "ID: " + oListItem.get_id() + "
" + + "Display name: " + oListItem.get_displayName() + "
" + + "Unique role assignments: " + oListItem.get_hasUniqueRoleAssignments() + "
"; + } + + resultpanel.innerHTML = listItemInfo; + } + + function errorHandler() { + resultpanel.innerHTML = "Request failed: " + arguments[1].get_message(); + } +} + +// Create, update and delete list items +function createListItem(resultpanel: HTMLElement) { + var clientContext = SP.ClientContext.get_current(); + var oWebsite = clientContext.get_web(); + var oList = oWebsite.get_lists().getByTitle("Announcements"); + + var itemCreateInfo = new SP.ListItemCreationInformation(); + var oListItem = oList.addItem(itemCreateInfo); + oListItem.set_item("Title", "My New Item!"); + oListItem.set_item("Body", "Hello World!"); + oListItem.update(); + + clientContext.load(oListItem); + clientContext.executeQueryAsync( + successHandler, + errorHandler + ); + + function successHandler() { + resultpanel.innerHTML = "Go to the list to see your new item."; + } + + function errorHandler() { + resultpanel.innerHTML = "Request failed: " + arguments[1].get_message(); + } +} + +function updateListItem(resultpanel: HTMLElement) { + var clientContext = SP.ClientContext.get_current(); + var oWebsite = clientContext.get_web(); + var oList = oWebsite.get_lists().getByTitle("Announcements"); + + var oListItem = oList.getItemById(1); + oListItem.set_item("Title", "My updated title"); + oListItem.update(); + + clientContext.load(oListItem); + clientContext.executeQueryAsync( + successHandler, + errorHandler + ); + + function successHandler() { + resultpanel.innerHTML = "Go to the list to see your updated item."; + } + + function errorHandler() { + resultpanel.innerHTML = "Request failed: " + arguments[1].get_message(); + } +} + +function deleteListItem(resultpanel: HTMLElement) { + var clientContext = SP.ClientContext.get_current(); + var oWebsite = clientContext.get_web(); + var oList = oWebsite.get_lists().getByTitle("Announcements"); + + var oListItem = oList.getItemById(1); + oListItem.deleteObject(); + + clientContext.executeQueryAsync( + successHandler, + errorHandler + ); + + function successHandler() { + resultpanel.innerHTML = "Go to the list to make sure the item is no longer there."; + } + + function errorHandler() { + resultpanel.innerHTML = "Request failed: " + arguments[1].get_message(); + } +} \ No newline at end of file diff --git a/sharepoint/SharePoint.d.ts b/sharepoint/SharePoint.d.ts new file mode 100644 index 0000000000..056087bedb --- /dev/null +++ b/sharepoint/SharePoint.d.ts @@ -0,0 +1,7944 @@ +// Type definitions for sptypescript +// Project: http://sptypescript.codeplex.com +// Definitions by: Stanislav Vyshchepan and Andrey Markeev +// Definitions: https://github.com/borisyankov/DefinitelyTyped + + +declare module Sys { + export class EventArgs { + static Empty: Sys.EventArgs; + } + export class StringBuilder { + /** Appends a string to the string builder */ + append(s: string): void; + /** Appends a line to the string builder */ + appendLine(s: string): void; + /** Clears the contents of the string builder */ + clear(): void; + /** Indicates wherever the string builder is empty */ + isEmpty(): bool; + /** Gets the contents of the string builder as a string */ + toString(): string; + } + export class Component { + get_id(): string; + static create(type: Component, properties?: any, events?: any, references?: any, element?: Node); + initialize(): void; + updated(): void; + } + module UI { + export class Control { } + export class DomEvent { + static addHandler(element: HTMLElement, eventName: string, handler: (e: Event) => void ); + static removeHandler(element: HTMLElement, eventName: string, handler: (e: Event) => void ); + } + } + module Net { + export class WebRequest { } + export class WebRequestExecutor { } + } + interface IDisposable { + dispose(): void; + } + +} + +declare var $get: { (id: string): HTMLElement; }; +declare var $addHandler: { (element: HTMLElement, eventName: string, handler: (e: Event) => void ): void; }; +declare var $removeHandler: { (element: HTMLElement, eventName: string, handler: (e: Event) => void ): void; }; + +interface MQuery +{ + (selector: string, context?: any): MQueryResultSetElements; + (element: HTMLElement): MQueryResultSetElements; + (object: MQueryResultSetElements): MQueryResultSetElements; + (object: MQueryResultSet): MQueryResultSet; + (object: T): MQueryResultSet; + (elementArray: HTMLElement[]): MQueryResultSetElements; + (array: T[]): MQueryResultSet; + (): MQueryResultSet; + + throttle(fn: Function, interval: number, shouldOverrideThrottle: boolean): Function; + + extend(target: any, ...objs: any[]): Object; + extend(deep: boolean, target: any, ...objs: any[]): Object; + + makeArray(obj: any): any[]; + + isDefined(obj: any): boolean; + isNotNull(obj: any): boolean; + isUndefined(obj: any): boolean; + isNull(obj: any): boolean; + isUndefinedOrNull(obj: any): boolean; + isDefinedAndNotNull(obj: any): boolean; + isString(obj: any): boolean; + isBoolean(obj: any): boolean; + isFunction(obj: any): boolean; + isArray(obj: any): boolean; + isNode(obj: any): boolean; + isElement(obj: any): boolean; + isMQueryResultSet(obj: any): boolean; + isNumber(obj: any): boolean; + isObject(obj: any): boolean; + isEmptyObject(obj: any): boolean; + + ready(callback: () => void ): void; + contains(container: HTMLElement, contained: HTMLElement): boolean; + + proxy(fn: (...args: any[]) => any, context: any, ...args: any[]): Function; + proxy(context: any, name: string, ...args: any[]): any; + + every(obj: T[], fn: (elementOfArray: T, indexInArray: number) => boolean, context?: any): boolean; + every(obj: MQueryResultSet, fn: (elementOfArray: T, indexInArray: number) => boolean, context?: any): boolean; + every(obj: T[], fn: (elementOfArray: T) => boolean, context?: any): boolean; + every(obj: MQueryResultSet, fn: (elementOfArray: any) => boolean, context?: any): boolean; + + some(obj: T[], fn: (elementOfArray: T, indexInArray: number) => boolean, context?: any): boolean; + some(obj: MQueryResultSet, fn: (elementOfArray: T, indexInArray: number) => boolean, context?: any): boolean; + some(obj: T[], fn: (elementOfArray: T) => boolean, context?: any): boolean; + some(obj: MQueryResultSet, fn: (elementOfArray: T) => boolean, context?: any): boolean; + + filter(obj: T[], fn: (elementOfArray: T, indexInArray: number) => boolean, context?: any): T[]; + filter(obj: MQueryResultSet, fn: (elementOfArray: T, indexInArray: number) => boolean, context?: any): MQueryResultSet; + filter(obj: T[], fn: (elementOfArray: T) => boolean, context?: any): T[]; + filter(obj: MQueryResultSet, fn: (elementOfArray: T) => boolean, context?: any): MQueryResultSet; + + forEach(obj: T[], fn: (elementOfArray: T, indexInArray: number) => void, context?: any): void; + forEach(obj: MQueryResultSet, fn: (elementOfArray: T, indexInArray: number) => void, context?: any): void; + forEach(obj: T[], fn: (elementOfArray: T) => void, context?: any): void; + forEach(obj: MQueryResultSet, fn: (elementOfArray: T) => void, context?: any): void; + + map(array: T[], callback: (elementOfArray: T, indexInArray: number) => U): U[]; + map(array: MQueryResultSet, callback: (elementOfArray: T, indexInArray: number) => U): MQueryResultSet; + map(array: T[], callback: (elementOfArray: T) => U): U[]; + map(array: MQueryResultSet, callback: (elementOfArray: T) => U): MQueryResultSet; + + indexOf(obj: T[], object: T, startIndex?: number): number; + lastIndexOf(obj: T[], object: T, startIndex?: number): number; + + data(element: HTMLElement, key: string, value: any): any; + data(element: HTMLElement, key: string): any; + data(element: HTMLElement): any; + + removeData(element: HTMLElement, name?: string): MQueryResultSet; + hasData(element: HTMLElement): boolean; +} + +interface MQueryResultSetElements extends MQueryResultSet{ + append(node: HTMLElement): MQueryResultSetElements; + append(mQuerySet: MQueryResultSetElements): MQueryResultSetElements; + append(html: string): MQueryResultSetElements; + + bind(eventType: string, handler: (eventObject: MQueryEvent) => any): MQueryResultSetElements; + unbind(eventType: string, handler: (eventObject: MQueryEvent) => any): MQueryResultSetElements; + trigger(eventType: string): MQueryResultSet; + one(eventType: string, handler: (eventObject: MQueryEvent) => any): MQueryResultSetElements; + + detach(): MQueryResultSet; + + find(selector: string): MQueryResultSetElements; + closest(selector: string, context?: any): MQueryResultSetElements; + offset(): { left: number; top: number; }; + offset(coordinates: { left: any; top: any; }): MQueryResultSetElements; + + filter(selector: string): MQueryResultSetElements; + filter(fn: (elementOfArray: HTMLElement, indexInArray: number) => boolean, context?: any): MQueryResultSetElements; + filter(fn: (elementOfArray: HTMLElement) => boolean, context?: any): MQueryResultSetElements; + + not(selector: string): MQueryResultSetElements; + + parent(selector?: string): MQueryResultSetElements; + + offsetParent(selector?: string): MQueryResultSetElements; + + parents(selector?: string): MQueryResultSetElements; + parentsUntil(selector?: string, filter?: string): MQueryResultSetElements; + parentsUntil(element?: HTMLElement, filter?: string): MQueryResultSetElements; + + position(): { top: number; left: number; }; + + attr(attributeName: string): string; + attr(attributeName: string, value: any): MQueryResultSetElements; + attr(map: { [key: string]: any; }): MQueryResultSetElements; + attr(attributeName: string, func: (index: number, attr: any) => any): MQueryResultSetElements; + + addClass(classNames: string): MQueryResultSetElements; + removeClass(classNames: string): MQueryResultSetElements; + + css(propertyName: string): string; + css(propertyNames: string[]): string; + css(properties: any): MQueryResultSetElements; + css(propertyName: string, value: any): MQueryResultSetElements; + css(propertyName: any, value: any): MQueryResultSetElements; + + remove(selector?: string): MQueryResultSetElements; + children(selector?: string): MQueryResultSetElements; + empty(): MQueryResultSetElements; + first(): MQueryResultSetElements; + + data(key: string, value: any): MQueryResultSetElements; + data(obj: { [key: string]: any; }): MQueryResultSetElements; + data(key: string): any; + + removeData(key: string): MQueryResultSetElements; + + map(callback: (elementOfArray: HTMLElement, indexInArray: number) => any): MQueryResultSetElements; + map(callback: (elementOfArray: HTMLElement) => any): MQueryResultSetElements; + + blur(): MQueryResultSetElements; + blur(handler: (eventObject: MQueryEvent) => any): MQueryResultSetElements; + change(): MQueryResultSetElements; + change(handler: (eventObject: MQueryEvent) => any): MQueryResultSetElements; + click(): MQueryResultSetElements; + click(handler: (eventObject: MQueryEvent) => any): MQueryResultSetElements; + dblclick(): MQueryResultSetElements; + dblclick(handler: (eventObject: MQueryEvent) => any): MQueryResultSetElements; + error(): MQueryResultSetElements; + error(handler: (eventObject: MQueryEvent) => any): MQueryResultSetElements; + focus(): MQueryResultSetElements; + focus(handler: (eventObject: MQueryEvent) => any): MQueryResultSetElements; + focusin(): MQueryResultSetElements; + focusin(handler: (eventObject: MQueryEvent) => any): MQueryResultSetElements; + focusout(): MQueryResultSetElements; + focusout(handler: (eventObject: MQueryEvent) => any): MQueryResultSetElements; + keydown(): MQueryResultSetElements; + keydown(handler: (eventObject: MQueryEvent) => any): MQueryResultSetElements; + keypress(): MQueryResultSetElements; + keypress(handler: (eventObject: MQueryEvent) => any): MQueryResultSetElements; + keyup(): MQueryResultSetElements; + keyup(handler: (eventObject: MQueryEvent) => any): MQueryResultSetElements; + load(): MQueryResultSetElements; + load(handler: (eventObject: MQueryEvent) => any): MQueryResultSetElements; + mousedown(): MQueryResultSetElements; + mousedown(handler: (eventObject: MQueryEvent) => any): MQueryResultSetElements; + mouseenter(): MQueryResultSetElements; + mouseenter(handler: (eventObject: MQueryEvent) => any): MQueryResultSetElements; + mouseleave(): MQueryResultSetElements; + mouseleave(handler: (eventObject: MQueryEvent) => any): MQueryResultSetElements; + mousemove(): MQueryResultSetElements; + mousemove(handler: (eventObject: MQueryEvent) => any): MQueryResultSetElements; + mouseout(): MQueryResultSetElements; + mouseout(handler: (eventObject: MQueryEvent) => any): MQueryResultSetElements; + mouseover(): MQueryResultSetElements; + mouseover(handler: (eventObject: MQueryEvent) => any): MQueryResultSetElements; + mouseup(): MQueryResultSetElements; + mouseup(handler: (eventObject: MQueryEvent) => any): MQueryResultSetElements; + resize(): MQueryResultSetElements; + resize(handler: (eventObject: MQueryEvent) => any): MQueryResultSetElements; + scroll(): MQueryResultSetElements; + scroll(handler: (eventObject: MQueryEvent) => any): MQueryResultSetElements; + select(): MQueryResultSetElements; + select(handler: (eventObject: MQueryEvent) => any): MQueryResultSetElements; + submit(): MQueryResultSetElements; + submit(handler: (eventObject: MQueryEvent) => any): MQueryResultSetElements; + unload(): MQueryResultSetElements; + unload(handler: (eventObject: MQueryEvent) => any): MQueryResultSetElements; + +} + +interface MQueryResultSet { + contains(contained: T): boolean; + + filter(fn: (elementOfArray: T, indexInArray: number) => boolean, context?: any): MQueryResultSet; + filter(fn: (elementOfArray: T) => boolean, context?: any): MQueryResultSet; + + every(fn: (elementOfArray: T, indexInArray: number) => boolean, context?: any): boolean; + every(fn: (elementOfArray: T) => boolean, context?: any): boolean; + + some(fn: (elementOfArray: T, indexInArray: number) => boolean, context?: any): boolean; + some(fn: (elementOfArray: T) => boolean, context?: any): boolean; + + map(callback: (elementOfArray: T, indexInArray: number) => any): MQueryResultSet; + map(callback: (elementOfArray: T) => any): MQueryResultSet; + + forEach(fn: (elementOfArray: T, indexInArray: number) => void, context?: any): void; + forEach(fn: (elementOfArray: T) => void, context?: any): void; + + indexOf(object: any, startIndex?: number): number; + lastIndexOf(object: any, startIndex?: number): number; + +} + +interface MQueryEvent extends Event { + altKey: boolean; + attrChange: number; + attrName: string; + bubbles: boolean; + button: number; + cancelable: boolean; + ctrlKey: boolean; + defaultPrevented: boolean; + detail: number; + eventPhase: number; + newValue: string; + prevValue: string; + relatedNode: HTMLElement; + screenX: number; + screenY: number; + shiftKey: boolean; + view: any; +} + +declare var m$: MQuery; +declare class CalloutActionOptions { + /** Text for the action link */ + text: string; + tooltip: string; + disabledTooltip: string; + /** Callback that is executed when the action link is clicked. + @param event Standard javascript event object + @param action The action object */ + onClickCallback: (event: Event, action: CalloutAction) => any; + /** Callback which returns if the action link is enabled */ + isEnabledCallback: (action: CalloutAction) => bool; + /** Callback which returns if the action link is visible */ + isVisibleCallback: (action: CalloutAction) => bool; + /** Submenu entries for the action. If defined, the action link click will popup the specified menu. */ + menuEntries: CalloutActionMenuEntry[]; +} + +/** Defines a callout action menu entry */ +declare class CalloutActionMenuEntry { + /** Creates a callout action menu entry + @param text Text to be displayed as the menu item text + @param onClickCallback Callback that will be fired when the item is clicked + @param wzISrc Url of the icon + @param wzIAlt Alternative text for the icon image + @param wzISeq Sequence for the menu item + @param wzDesc Description of the menu item */ + constructor( + text: string, + onClickCallback: (actionMenuEntry: CalloutActionMenuEntry, actionMenuEntryIndex: number) => void, + wzISrc: string, + wzIAlt: string, + wzISeq: number, + wzDesc: string); +} + + +declare class CalloutActionMenu { + constructor(actionsId); + addAction(action: CalloutAction); + getActions(): CalloutAction[]; + render(): void; + refreshActions(): void; + calculateActionWidth(): void; +} + + +declare class CalloutAction { + constructor(options: CalloutActionOptions); + getText(): string; + getToolTop(): string; + getDisabledToolTip(): string; + getOnClickCallback(): (event, action: CalloutAction) => any; + getIsDisabledCallback(): (action: CalloutAction) => bool; + getIsVisibleCallback(): (action: CalloutAction) => bool; + getIsMenu(): bool; + getMenuEntries(): CalloutActionMenuEntry[]; + render(): void; + isEnabled(): bool; + isVisible(): bool; + set (options: CalloutActionOptions): void; +} + +declare class Callout { + /** Sets options for the callout. Not all options can be changed for the callout after its creation. */ + set (options: CalloutOptions); + /** Adds event handler to the callout. + @param eventName one of the following: "opened", "opening", "closing", "closed" */ + addEventCallback(eventName: string, callback: (callout: Callout) => void); + /** Returns the launch point element of the callout. */ + getLaunchPoint(): HTMLElement; + /** Returns the ID of the callout. */ + getID(): string; + /** Returns the title of the callout. */ + getTitle(): string; + /** Returns the contents of the callout. */ + getContent(): string; + /** Returns the content element of the callout. */ + getContentElement(): HTMLElement; + /** Returns the bounding element defined for the callout during its creation. */ + getBoundingBox(): HTMLElement; + /** Returns the content width defined for the callout during its creation. */ + getContentWidth(): number; + /** Returns the object that represents open behaivor defined for the callout during its creation. */ + getOpenOptions(): CalloutOpenOptions; + /** Returns the beak orientation defined for the callout during its creation. */ + getBeakOrientation(): string; + /** Returns the position algorithm function defined for the callout during its creation. */ + getPositionAlgorithm(): any; + /** Specifies wherever callout is in "Opened" state */ + isOpen(): bool; + /** Specifies wherever callout is in "Opening" state */ + isOpening(): bool; + /** Specifies wherever callout is in "Opened" or "Opening" state */ + isOpenOrOpening(): bool; + /** Specifies wherever callout is in "Closing" state */ + isClosing(): bool; + /** Specifies wherever callout is in "Closed" state */ + isClosed(): bool; + /** Returns the callout actions menu */ + getActionMenu(): CalloutActionMenu; + /** Adds a link to the actions panel in the bottom part of the callout window */ + addAction(action: CalloutAction); + /** Re-renders the actions menu. Call after the actions menu is changed. */ + refreshActions(): void; + /** Display the callout. Animation can be used only for IE9+ */ + open(useAnimation: bool); + /** Hide the callout. Animation can be used only for IE9+ */ + close(useAnimation: bool); + /** Display if hidden, hide if shown. */ + toggle(): void; + /** Do not call this directly. Instead, use CalloutManager.remove */ + destroy(): void; +} + +declare class CalloutOpenOptions { + /** HTML event name, e.g. "click" */ + event: string; + /** Callout will be closed on blur */ + closeCalloutOnBlur: bool; + /** Close button will be shown within the callout window */ + showCloseButton: bool; +} + +declare class CalloutOptions { + /** Some unique id for the callout. */ + ID: string; + /** Element on that the callout is shown. */ + launchPoint: HTMLElement; + /** One of the following: "topBottom" (default) or "leftRight". */ + beakOrientation: string; + /** String (HTML allowed) that represents contents of the callout window. */ + content: string; + /** Title for the callout */ + title: string; + /** HTML element that represents contents of the callout window. */ + contentElement: HTMLElement; + /** If defined, callout will be inscribed into the bounding element. */ + boundingBox: HTMLElement; + /** Content element's width in pixels. By default = 350. */ + contentWidth: number; + /** Defines opening behavior */ + openOptions: CalloutOpenOptions; + /** Fires after the callout is rendered but before it is positioned and shown */ + onOpeningCallback: (callout: Callout) => void; + /** Fires right after the callout is shown */ + onOpenedCallback: (callout: Callout) => void; + /** Fires right before the callout is closed */ + onClosingCallback: (callout: Callout) => void; + /** Fires right after the callout is closed */ + onClosedCallback: (callout: Callout) => void; + /** Sets the position of the callout during its opening phase. For an example of a position algorithm function, please explore defaultPositionAlgorithm function from the callout.debug.js file */ + positionAlgorithm: (callout: Callout) => void; +} + + +declare class CalloutManager { + /** Creates a new callout */ + static createNew(options: CalloutOptions): Callout; + /** Checks if callout with specified ID already exists. If it doesn't, creates it, otherwise returns the existing one. */ + static createNewIfNecessary(options: CalloutOptions): Callout; + /** Detaches callout from the launch point and destroys it. */ + static remove(callout: Callout); + /** Searches for a callout associated with the specified launch point. Throws error if not found. */ + static getFromLaunchPoint(launchPoint: HTMLElement): Callout; + /** Searches for a callout associated with the specified launch point. Returns null if not found. */ + static getFromLaunchPointIfExists(launchPoint: HTMLElement): Callout; + /** Gets the first launch point within the specified ancestor element, and returns true if the associated with it callout is opened or opening. + If the launch point is not found or the callout is hidden, returns false. */ + static containsOneCalloutOpen(ancestor: HTMLElement): bool; + /** Finds the closest launch point based on the specified descendant element, and returns callout associated with the launch point. */ + static getFromCalloutDescendant(descendant: HTMLElement): Callout; + /** Perform some action for each callout on the page. */ + static forEach(callback: (callout: Callout) => void); + /** Closes all callouts on the page */ + static closeAll(): bool; + /** Returns true if at least one of the defined on page callouts is opened. */ + static isAtLeastOneCalloutOpen(): bool; + /** Returns true if at least one of the defined on page callouts is opened or opening. */ + static isAtLeastOneCalloutOn(): bool; +} + + +declare module SPClientTemplates { + + export enum FileSystemObjectType { + Invalid, + File, + Folder, + Web + } + export enum ChoiceFormatType { + Dropdown, + Radio + } + + export enum ClientControlMode { + Invalid, + DisplayForm, + EditForm, + NewForm, + View + } + + export enum RichTextMode { + Compatible, + FullHtml, + HtmlAsXml, + ThemeHtml + } + export enum UrlFormatType { + Hyperlink, + Image + } + + export enum DateTimeDisplayFormat { + DateOnly, + DateTime, + TimeOnly + } + + export enum DateTimeCalendarType { + None, + Gregorian, + Japan, + Taiwan, + Korea, + Hijri, + Thai, + Hebrew, + GregorianMEFrench, + GregorianArabic, + GregorianXLITEnglish, + GregorianXLITFrench, + KoreaJapanLunar, + ChineseLunar, + SakaEra, + UmAlQura + } + export enum UserSelectionMode { + PeopleOnly, + PeopleAndGroups + } + + /** Represents schema for a Choice field in list form or in list view in grid mode */ + export interface FieldSchema_InForm_Choice extends FieldSchema_InForm { + /** List of choices for this field. */ + Choices: string[]; + /** Display format for the choice field */ + FormatType: ChoiceFormatType; + } + /** Represents schema for a Lookup field in list form or in list view in grid mode */ + export interface FieldSchema_InForm_Lookup extends FieldSchema_InForm { + /** Specifies if the field allows multiple values */ + AllowMultipleValues: bool; + /** Returns base url for a list display form, e.g. "http://portal/web/_layouts/15/listform.aspx?PageType=4" + You must add "ListId" (Guid of the list) and "ID" (integer Id of the item) parameters in order to use this Url */ + BaseDisplayFormUrl: string; + /** Indicates if the field is a dependent lookup */ + DependentLookup: bool; + /** Indicates wherever the lookup list is throttled (contains more items than value of the "List Throttle Limit" setting). */ + Throttled: bool; + /** Returns string representation of a number that represents the current value for the "List Throttle Limit" web application setting. + Only appears if Throttled property is true, i.e. the target lookup list is throttled. */ + MaxQueryResult: string; + /** List of choices for this field. + For a lookup field, contains array of possible values pulled from the target lookup list. */ + Choices: string[]; + /** Number of choices. Appears only for Lookup field. */ + ChoiceCount: number; + + LookupListId: string; + + } + /** Represents schema for a DateTime field in list form or in list view in grid mode */ + export interface FieldSchema_InForm_DateTime extends FieldSchema_InForm { + /** Type of calendar to use */ + CalendarType: DateTimeCalendarType; + /** Display format for DateTime field. */ + DisplayFormat: DateTimeDisplayFormat; + /** Indicates wherever current user regional settings specify to display week numbers in day or week views of a calendar. + Only appears for DateTime fields. */ + ShowWeekNumber: bool; + TimeSeparator: string; + TimeZoneDifference: string; + FirstDayOfWeek: number; + FirstWeekOfYear: number; + HijriAdjustment: number; + WorkWeek: string; + LocaleId: string; + LanguageId: string; + MinJDay: number; + MaxJDay: number; + HoursMode24: bool; + HoursOptions: string[]; + } + /** Represents schema for a DateTime field in list form or in list view in grid mode */ + export interface FieldSchema_InForm_Geolocation extends FieldSchema_InForm { + BingMapsKey: string; + IsBingMapBlockedInCurrentRegion: bool; + } + /** Represents schema for a Choice field in list form or in list view in grid mode */ + export interface FieldSchema_InForm_MultiChoice extends FieldSchema_InForm { + /** List of choices for this field. */ + MultiChoices: string[]; + /** Indicates wherever fill-in choice is allowed */ + FillInChoice: bool; + } + /** Represents schema for a Choice field in list form or in list view in grid mode */ + export interface FieldSchema_InForm_MultiLineText extends FieldSchema_InForm { + /** Specifies whether rich text formatting can be used in the field */ + RichText: bool; + /** Changes are appended to the existing text. */ + AppendOnly: bool; + /** Rich text mode for the field */ + RichTextMode: RichTextMode; + /** Number of lines configured to display */ + NumberOfLines: number; + /** A boolean value that specifies whether hyperlinks can be used in this fields. */ + AllowHyperlink: bool; + /** WebPartAdderId for the ScriptEditorWebPart */ + ScriptEditorAdderId: string; + } + /** Represents schema for a Number field in list form or in list view in grid mode */ + export interface FieldSchema_InForm_Number extends FieldSchema_InForm { + ShowAsPercentage: bool; + } + /** Represents schema for a Number field in list form or in list view in grid mode */ + export interface FieldSchema_InForm_Text extends FieldSchema_InForm { + MaxLength: number; + } + /** Represents schema for a Number field in list form or in list view in grid mode */ + export interface FieldSchema_InForm_Url extends FieldSchema_InForm { + DisplayFormat: UrlFormatType; + } + /** Represents schema for a Number field in list form or in list view in grid mode */ + export interface FieldSchema_InForm_User extends FieldSchema_InForm { + Presence: bool; + WithPicture: bool; + DefaultRender: bool; + WithPictureDetail: bool; + /** Server relative Url for ~site/_layouts/listform.aspx */ + ListFormUrl: string; + /** Server relative Url for ~site/_layouts/userdisp.aspx */ + UserDisplayUrl: string; + EntitySeparator: string; + PictureOnly: bool; + PictureSize: string; + } + /** Represents field schema in Grid mode and on list forms. + Consider casting objects of this type to more specific field types, e.g. FieldSchemaInForm_Lookup */ + export interface FieldSchema_InForm { + /** Specifies if the field can be edited while list view is in the Grid mode */ + AllowGridEditing: bool; + /** Description for this field. */ + Description: string; + /** Direction of the reading order for the field. */ + Direction: string; + /** String representation of the field type, e.g. "Lookup". Same as SPField.TypeAsString */ + FieldType: string; + /** Indicates whether the field is hidden */ + Hidden: bool; + /** Guid of the field */ + Id: string; + /** Specifies Input Method Editor (IME) mode bias to use for the field. + The IME enables conversion of keystrokes between languages when one writing system has more characters than can be encoded for the given keyboard. */ + IMEMode: any; + /** Internal name of the field */ + Name: string; + /** Specifies if the field is read only */ + ReadOnlyField: bool; + /** Specifies wherever field requires values */ + Required: bool; + RestrictedMode: bool; + /** Title of the field */ + Title: string; + /** For OOTB fields, returns the type of field. For "UserMulti" returns "User", for "LookupMulti" returns "Lookup". + For custom field types, returns base type of the field. */ + Type: string; + /** If SPFarm.Local.UseMinWidthForHtmlPicker is true, UseMinWidth will be set to true. Undefined in other cases. */ + UseMinWidth: bool; + } + export interface ListSchema_InForm { + Field: FieldSchema_InForm[]; + } + export interface ListData_InForm { + Items: Item[]; + } + export interface RenderContext_FieldInForm extends RenderContext_Form { + CurrentGroupIdx: number; + CurrentGroup: Group; + CurrentItems: Item[]; + CurrentFieldSchema: FieldSchema_InForm; + CurrentFieldValue: any; + } + export interface RenderContext_Form extends RenderContext { + CurrentItem: Item; + FieldControlModes: { [fieldInternalName: string]: ClientControlMode; }; + FormContext: ClientFormContext; + FormUniqueId: string; + ListData: ListData_InForm; + ListSchema: ListSchema_InForm; + } + + + + export interface FieldSchema_InView_LookupField extends FieldSchema_InView { + /** Either "TRUE" or "FALSE" */ + AllowMultipleValues: string; + /** Target lookup list display form URL, including PageType and List attributes. */ + DispFormUrl: string; + /** Either "TRUE" or "FALSE" */ + HasPrefix: string; + } + export interface FieldSchema_InView_UserField extends FieldSchema_InView { + /** Either "TRUE" or "FALSE" */ + AllowMultipleValues: string; + /** Either "TRUE" or "FALSE" */ + ImnHeader: string; + /** Either "TRUE" or "FALSE" */ + HasPrefix: string; + /** Either "1" or "0" */ + HasUserLink: string; + /** Either "1" or "0" */ + DefaultRender: string; + } + /** Represents field schema in a list view. */ + export interface FieldSchema_InView { + /** Either "TRUE" or "FALSE" */ + AllowGridEditing: string; + /** Either "TRUE" or "FALSE" */ + CalloutMenu: string; + ClassInfo: string; // e.g. "Menu" + css: string; + DisplayName: string; + /** Either "TRUE" or "FALSE" */ + Explicit: string; + fieldRenderer: any; + FieldTitle: string; + /** Represents SPField.TypeAsString, e.g. "Computed", "UserMulti", etc. */ + FieldType: string; + /** Indicates whether the field can be filtered. Either "TRUE" or "FALSE" */ + Filterable: string; + /** Set to "TRUE" for fields that comply to the following Xpath query: + ViewFields/FieldRef[@Explicit='TRUE'] | Query/GroupBy/FieldRef[not(@Name=ViewFields/FieldRef/@Name)] */ + GroupField: string; + /** Either "TRUE" or "FALSE" */ + GridActiveAndReadOnly: string; + /** Guid of the field */ + ID: string; + /** Specifies if the field contains list item menu. + Corresponds to ViewFields/FieldRef/@ListItemMenu attribute. Either "TRUE" or "FALSE" and might be missing. */ + listItemMenu: string; + Name: string; + RealFieldName: string; + /** Either "TRUE" or "FALSE" */ + ReadOnly: string; + ResultType: string; + /** Indicates whether the field can be sorted. Either "TRUE" or "FALSE" */ + Sortable: string; + Type: string; + } + export interface ListSchema_InView { + /** Key-value object that represents all aggregations defined for the view. + Key specifies the field internal name, and value specifies the type of the aggregation. */ + Aggregate: { [name: string]: string; }; + /** Either "TRUE" or false (for grouping) */ + Collapse: string; + /** Specifies whether to open items in a client application ("1") or in browser ("0"). */ + DefaultItemOpen: string; + Direction: string; + /** Either "0" or "1" */ + EffectivePresenceEnabled: string; + /** If in grid mode (context.inGridMode == true), cast to FieldSchema_InForm[], otherwise cast to FieldSchema_InView[] */ + Field: any[]; + FieldSortParam: string; + Filter: any; + /** Either "0" or "1" */ + ForceCheckout: string; + /** Internal name for the first group by field, if any */ + group1: string; + /** Internal name for the second group by field, if any */ + group2: string; + /** "1" if the view contains "Title" field, otherwise not defined. */ + HasTitle: string; + HttpVDir: string; + /** Either "0" or "1" */ + InplaceSearchEnabled: string; + /** Either "0" or "1" */ + IsDocLib: string; + /** e.g. "1033" */ + LCID: string; + /** Either "0" or "1" */ + ListRight_AddListItems: string; + NoListItem: string; + NoListItemHowTo: string; + /** Server-relative path to the current page */ + PagePath: string; + /** Internal name of the field inside which the hierarchy buttons are displayed */ + ParentHierarchyDisplayField: string; + PresenceAlt: string; + /** Represents SPList.RootFolder.Properties. Exists only if SPList.FetchPropertyBagForListView property is set to true. */ + PropertyBag: { [key: string]: string; }; + /** Either "True" or "False" */ + RenderSaveAsNewViewButton: string; + /** Either "True" or "False" */ + RenderViewSelectorPivotMenu: string; + /** Either "True" or "False" */ + RenderViewSelectorPivotMenuAsync: string; + /** Query string parameters that specify GUID of the current view and the current root folder */ + RootFolderParam: string; + SelectedID: string; // number + ShowWebPart: string; + /** Either "1" or undefined. */ + StrikeThroughOnCompletedEnabled: string; + /** Either "0" or "1" */ + TabularView: string; + Toolbar: string; + UIVersion: string; // number + Userid: string; // number + UserVanilla: any; + /** Server relative path to "/_layouts/userdisp.aspx" in the current web */ + UserDispUrl: string; + /** Either "1" or "" */ + UseParentHierarchy: string; + /** Guid of the view */ + View: string; + /** JSON string */ + ViewSelectorPivotMenuOptions: string; + /** Query string parameters that specify current root folder (RootFolder) and folder content type id (FolderCTID) */ + ViewSelector_ViewParameters: string; + } + export interface ListData_InView { + FilterLink: string; + FilterFields: string; + FirstRow: number; + /** Either "0" or "1" */ + ForceNoHierarchy: string; + HierarchyHasIndention: string; + /** Link to the previous page (not defined if not available) */ + PrevHref: string; + /** Link to the next page (not defined if not available) */ + NextHref: string; + SortField: string; + SortDir: string; + LastRow: number; + Row: Item[]; + } + export interface RenderContext_GroupInView extends RenderContext_InView { + CurrentGroupIdx: number; + CurrentGroup: Group; + CurrentItems: Item[]; + } + export interface RenderContext_InView extends RenderContext { + AllowCreateFolder: bool; + AllowGridMode: bool; + BasePermissions: { [PermissionName: string]: bool; }; // SP.BasePermissions? + bInitialRender: bool; + CanShareLinkForNewDocument: bool; + CascadeDeleteWarningMessage: string; + clvp: HTMLElement; // not in View + ContentTypesEnabled: bool; + ctxId: number; + ctxType: any; // not in View + CurrentUserId: number; + CurrentUserIsSiteAdmin: bool; + dictSel: any; + /** Absolute path for the list display form */ + displayFormUrl: string; + /** Absolute path for the list edit form */ + editFormUrl: string; + EnableMinorVersions: bool; + ExternalDataList: bool; + enteringGridMode: bool; + existingServerFilterHash: any; + HasRelatedCascadeLists: number; + heroId: string; // e.g. "idHomePageNewItem" + HttpPath: string; + HttpRoot: string; + imagesPath: string; + inGridFullRender: any; // not in View + inGridMode: bool; + IsAppWeb: bool; + IsClientRendering: bool; + isForceCheckout: bool; + isModerated: bool; + isPortalTemplate: any; + isWebEditorPreview: number; + isVersions: number; + isXslView: bool; + LastRowIndexSelected: any; // not in View + LastSelectableRowIdx: any; + LastSelectedItemId: any; // not in View + leavingGridMode: bool; + listBaseType: number; + ListData: ListData_InView; + ListDataJSONItemsKey: string; // ="Row" + /** Guid of the list */ + listName: string; + ListSchema: ListSchema_InView; + listTemplate: string; + ListTitle: string; + listUrlDir: string; + loadingAsyncData: bool; + ModerationStatus: number; + NavigateForFormsPages: bool; + /** Absolute path for the list new form */ + newFormUrl: string; + NewWOPIDocumentEnabled: any; + NewWOPIDocumentUrl: any; + noGroupCollapse: bool; + OfficialFileName: string; + OfficialFileNames: string; + overrideDeleteConfirmation: string; // not in View + overrideFilterQstring: string; // not in View + PortalUrl: string; + queryString: any; + recursiveView: bool; + /** either 1 or 0 */ + RecycleBinEnabled: number; + RegionalSettingsTimeZoneBias: string; + rootFolder: string; + rootFolderForDisplay: any; + RowFocusTimerID: any; + SelectAllCbx: any; + SendToLocationName: string; + SendToLocationUrl: string; + serverUrl: any; + SiteTitle: string; + StateInitDone: bool; + TableCbxFocusHandler: any; + TableMouseOverHandler: any; + TotalListItems: any; + verEnabled: number; + /** Guid of the view. */ + view: string; + viewTitle: string; + WorkflowAssociated: bool; + wpq: string; + WriteSecurity: string; + } + export interface RenderContext_ItemInView extends RenderContext_InView { + CurrentItem: Item; + CurrentItemIdx: number; + } + export interface RenderContext_FieldInView extends RenderContext_ItemInView { + /** If in grid mode (context.inGridMode == true), cast to FieldSchema_InForm, otherwise cast to FieldSchema_InView */ + CurrentFieldSchema: any; + CurrentFieldValue: any; + FieldControlsModes: { [fieldInternalName: string]: ClientControlMode; }; + FormContext: any; + FormUniqueId: string; + } + + export interface Item { + [fieldInternalName: string]: any; + } + export interface Group { + Items: Item[]; + } + + export interface RenderContext { + BaseViewID: number; + ControlMode: ClientControlMode; + CurrentCultureName: string; + CurrentLanguage: number; + CurrentSelectedItems: any; + CurrentUICultureName: string; + ListTemplateType: number; + OnPostRender: any; + OnPreRender: any; + onRefreshFailed: any; + RenderBody: (renderContext: RenderContext) => string; + RenderFieldByName: (renderContext: RenderContext, fieldName: string) => string; + RenderFields: (renderContext: RenderContext) => string; + RenderFooter: (renderContext: RenderContext) => string; + RenderGroups: (renderContext: RenderContext) => string; + RenderHeader: (renderContext: RenderContext) => string; + RenderItems: (renderContext: RenderContext) => string; + RenderView: (renderContext: RenderContext) => string; + SiteClientTag: string; + Templates: TemplateOverrides; + } + + export interface SingleTemplateCallback { + /** Must return null in order to fall back to a more common template or to a system default template */ + (renderContext: RenderContext_InView): string; + } + export interface GroupCallback { + /** Must return null in order to fall back to a more common template or to a system default template */ + (renderContext: RenderContext_GroupInView): string; + } + export interface ItemCallback { + /** Must return null in order to fall back to a more common template or to a system default template */ + (renderContext: RenderContext): string; + } + export interface FieldInFormCallback { + /** Must return null in order to fall back to a more common template or to a system default template */ + (renderContext: RenderContext_FieldInForm): string; + } + export interface FieldInViewCallback { + /** Must return null in order to fall back to a more common template or to a system default template */ + (renderContext: RenderContext_FieldInView): string; + } + + export interface FieldTemplateOverrides { + /** Defines templates for rendering the field on a display form. */ + DisplayForm?: FieldInFormCallback; + /** Defines templates for rendering the field on an edit form. */ + EditForm?: FieldInFormCallback; + /** Defines templates for rendering the field on a new form. */ + NewForm?: FieldInFormCallback; + /** Defines templates for rendering the field on a list view. */ + View?: FieldInViewCallback; + } + + export interface FieldTemplateMap { + [fieldInternalName: string]: FieldTemplateOverrides; + } + + export interface TemplateOverrides { + View?: (renderContext: any) => string; // TODO: determine appropriate context type and purpose of this template + Body?: (renderContext: any) => string; // TODO: determine appropriate context type and purpose of this template + /** Defines templates for rendering groups (aggregations). */ + Group?: GroupCallback; + /** Defines templates for list items rendering. */ + Item?: ItemCallback; + /** Defines template for rendering list view header. + Can be either string or SingleTemplateCallback */ + Header?: SingleTemplateCallback; + /** Defines template for rendering list view footer. + Can be either string or SingleTemplateCallback */ + Footer?: SingleTemplateCallback; + /** Defines templates for fields rendering. The field is specified by it's internal name. */ + Fields?: FieldTemplateMap; + } + export interface TemplateOverridesOptions { + /** Template overrides */ + Templates?: TemplateOverrides; + + /** �allbacks called before rendering starts. Can be function (ctx: RenderContext) => void or array of functions.*/ + OnPreRender?: any; + + /** �allbacks called after rendered html inserted into DOM. Can be function (ctx: RenderContext) => void or array of functions.*/ + OnPostRender?: any; + + /** View style (SPView.StyleID) for which the templates should be applied. + If not defined, the templates will be applied only to default view style. */ + ViewStyle?: number; + /** List template type (SPList.BaseTemplate) for which the template should be applied. + If not defined, the templates will be applied to all lists. */ + ListTemplateType?: number; + /** Base view ID (SPView.BaseViewID) for which the template should be applied. + If not defined, the templates will be applied to all views. */ + BaseViewID?: number; + } + export class TemplateManager { + static RegisterTemplateOverrides(renderCtx: TemplateOverridesOptions): void; + } + + export interface ClientUserValue { + lookupId: number; + lookupValue: string; + displayStr: string; + email: string; + sip: string; + title: string; + picture: string; + department: string; + jobTitle: string; + } + export interface ClientLookupValue { + LookupId: number; + LookupValue: string; + } + export interface ClientUrlValue { + URL: string; + Description: string; + } + export class Utility { + static ComputeRegisterTypeInfo(renderCtx: TemplateOverridesOptions): any; + static ControlModeToString(mode: SPClientTemplates.ClientControlMode): string; + static FileSystemObjectTypeToString(fileSystemObjectType: SPClientTemplates.FileSystemObjectType): string; + static ChoiceFormatTypeToString(fileSystemObjectType: SPClientTemplates.ChoiceFormatType): string; + static RichTextModeToString(fileSystemObjectType: SPClientTemplates.RichTextMode): string; + static IsValidControlMode(mode: number): bool; + /** Removes leading and trailing spaces */ + static Trim(str: string): string; + /** Creates SP.ClientContext based on the specified Web URL. If the SP.Runtime.js script is not loaded, returns null */ + static InitContext(webUrl: string): SP.ClientContext; + static GetControlOptions(control: HTMLElement): any; + static TryParseInitialUserValue(userStr: string): ClientUserValue[]; + /** Tries to resolve user names from string. Pushes either ClientUserValue (if resolved successfully) or original string (if not) to the resulting array. */ + static TryParseUserControlValue(userStr: string, separator: string): any[]; + static GetPropertiesFromPageContextInfo(context: RenderContext): void; + /** Replaces tokens "~site/", "~sitecollection/", "~sitecollectionmasterpagegallery", "{lcid}", "{locale}" and "{siteclienttag}" with appropriate context values */ + static ReplaceUrlTokens(tokenUrl: string): string; + static ParseLookupValue(valueStr: string): ClientLookupValue; + static ParseMultiLookupValues(valueStr: string): ClientLookupValue[]; + /** Represents lookup values array in some strange format */ + static BuildLookupValuesAsString(choiceArray: ClientLookupValue[], isMultiLookup: bool, setGroupDesc: bool): string; + static ParseURLValue(value: string): ClientUrlValue; + static GetFormContextForCurrentField(context: RenderContext_Form): ClientFormContext; + } + + export class ClientFormContext { + fieldValue: any; + fieldSchema: SPClientTemplates.FieldSchema_InForm; + fieldName: string; + controlMode: number; + webAttributes: { + AllowScriptableWebParts: bool; + CurrentUserId: number; + EffectivePresenceEnabled: bool; + LCID: string; + PermissionCustomizePages: bool; + WebUrl: string; + }; + itemAttributes: { + ExternalListItem: boolean; + FsObjType: number; + Id: number; + Url: string; + }; + listAttributes: { + BaseType: number; + DefaultItemOpen: number; + Direction: string; + EnableVesioning: bool; + Id: string; + }; + registerInitCallback(fieldname: string, callback: () => void ): void; + registerFocusCallback(fieldname: string, callback: () => void ): void; + registerValidationErrorCallback(fieldname: string, callback: (error: any) => void ): void; + registerGetValueCallback(fieldname: string, callback: () => any): void; + updateControlValue(fieldname: string, value: any): void; + registerClientValidator(fieldname: string, validator: SPClientForms.ClientValidation.ValidatorSet): void; + registerHasValueChangedCallback(fieldname: string, callback: (eventArg?: any) => void ); + } + +} + +declare function GenerateIID(renderCtx: SPClientTemplates.RenderContext_ItemInView): string; +declare function GenerateIIDForListItem(renderCtx: SPClientTemplates.RenderContext_InView, listItem: SPClientTemplates.Item): string; + +declare function SPFormControl_AppendValidationErrorMessage(nodeId: string, errorResult: any): void; +declare function CoreRender(template: any, context: any): string; + +declare module SPClientForms { + module ClientValidation { + export class ValidationResult { + constructor(hasErrors: bool, errorMsg: string); + } + + export class ValidatorSet { + public RegisterValidator(validator: IValidator); + } + + export interface IValidator { + Validate(value: any): ValidationResult; + } + + export class RequiredValidator implements IValidator { + Validate(value: any): ValidationResult; + } + } +} + + + +interface IEnumerator { + get_current(): T; + moveNext(): bool; + reset(): void; +} + +interface IEnumerable { + getEnumerator(): IEnumerator; +} + +declare module SP { + export class ScriptUtility { + static isNullOrEmptyString(str: string): bool; + static isNullOrUndefined(obj: any): bool; + static isUndefined(obj: any): bool; + static truncateToInt(n: number): number; + } + export class Guid { + constructor(guidText: string); + static get_empty(): SP.Guid; + static newGuid(): SP.Guid; + static isValid(uuid: string): bool; + toString(): string; + toString(format: string): string; + equals(uuid: SP.Guid): bool; + toSerialized(): string; + } + /** Specifies permissions that are used to define user roles. Represents SPBasePermissions class. */ + export enum PermissionKind { + /** Has no permissions on the Web site. Not available through the user interface. */ + emptyMask, + /** View items in lists, documents in document libraries, and view Web discussion comments. */ + viewListItems, + /** Add items to lists, add documents to document libraries, and add Web discussion comments. */ + addListItems, + /** Edit items in lists, edit documents in document libraries, edit Web discussion comments in documents, and customize Web Part Pages in document libraries. */ + editListItems, + /** Delete items from a list, documents from a document library, and Web discussion comments in documents. */ + deleteListItems, + /** Approve a minor version of a list item or document. */ + approveItems, + /** View the source of documents with server-side file handlers. */ + openItems, + /** View past versions of a list item or document. */ + viewVersions, + /** Delete past versions of a list item or document. */ + deleteVersions, + /** Discard or check in a document which is checked out to another user. */ + cancelCheckout, + /** Create, change, and delete personal views of lists. */ + managePersonalViews, + /** Create and delete lists, add or remove columns in a list, and add or remove public views of a list. */ + manageLists, + /** View forms, views, and application pages, and enumerate lists. */ + viewFormPages, + /** Make content of a list or document library retrieveable for anonymous users through SharePoint search. The list permissions in the site do not change. */ + anonymousSearchAccessList, + /** Allow users to open a Web site, list, or folder to access items inside that container. */ + open, + /** View pages in a Web site. */ + viewPages, + /** Add, change, or delete HTML pages or Web Part Pages, and edit the Web site using a SharePoint Foundation?compatible editor. */ + addAndCustomizePages, + /** Apply a theme or borders to the entire Web site. */ + applyThemeAndBorder, + /** Apply a style sheet (.css file) to the Web site. */ + applyStyleSheets, + /** View reports on Web site usage. */ + viewUsageData, + /** Create a Web site using Self-Service Site Creation. */ + createSSCSite, + /** Create subsites such as team sites, Meeting Workspace sites, and Document Workspace sites. */ + manageSubwebs, + /** Create a group of users that can be used anywhere within the site collection. */ + createGroups, + /** Create and change permission levels on the Web site and assign permissions to users and groups. */ + managePermissions, + /** Enumerate files and folders in a Web site using Microsoft Office SharePoint Designer 2007 and WebDAV interfaces. */ + browseDirectories, + /** View information about users of the Web site. */ + browseUserInfo, + /** Add or remove personal Web Parts on a Web Part Page. */ + addDelPrivateWebParts, + /** Update Web Parts to display personalized information. */ + updatePersonalWebParts, + /** Grant the ability to perform all administration tasks for the Web site as well as manage content. Activate, deactivate, or edit properties of Web site scoped Features through the object model or through the user interface (UI). When granted on the root Web site of a site collection, activate, deactivate, or edit properties of site collection scoped Features through the object model. To browse to the Site Collection Features page and activate or deactivate site collection scoped Features through the UI, you must be a site collection administrator. */ + manageWeb, + /** Content of lists and document libraries in the Web site will be retrieveable for anonymous users through SharePoint search if the list or document library has AnonymousSearchAccessList set. */ + anonymousSearchAccessWebLists, + /** Use features that launch client applications; otherwise, users must work on documents locally and upload changes. */ + useClientIntegration, + /** Use SOAP, WebDAV, or Microsoft Office SharePoint Designer 2007 interfaces to access the Web site. */ + useRemoteAPIs, + /** Manage alerts for all users of the Web site. */ + manageAlerts, + /** Create e-mail alerts. */ + createAlerts, + /** Allows a user to change his or her user information, such as adding a picture. */ + editMyUserInfo, + /** Enumerate permissions on the Web site, list, folder, document, or list item. */ + enumeratePermissions, + /** Has all permissions on the Web site. Not available through the user interface. */ + fullMask, + } + + export class BaseCollection implements IEnumerable { + getEnumerator(): IEnumerator; + get_count(): number; + itemAtIndex(index: number): T; + constructor(); + } + export interface IFromJson { + fromJson(initValue: any): void; + customFromJson(initValue: any): bool; + } + export class Base64EncodedByteArray { + constructor(); + constructor(base64Str: string); + get_length(): number; + toBase64String(): string; + append(b: any): void; + getByteAt(index: number): any; + setByteAt(index: number, b: any): void; + } + export class ConditionalScopeBase { + startScope(): any; + startIfTrue(): any; + startIfFalse(): any; + get_testResult(): bool; + fromJson(initValue: any): void; + customFromJson(initValue: any): bool; + } + export class ClientObjectPropertyConditionalScope extends SP.ConditionalScopeBase { + constructor(clientObject: SP.ClientObject, propertyName: string, comparisonOperator: string, valueToCompare: any); + constructor(clientObject: SP.ClientObject, propertyName: string, comparisonOperator: string, valueToCompare: any, allowAllActions: bool); + } + export class ClientResult { + get_value(): any; + setValue(value: any): void; + constructor(); + } + export class BooleanResult { + get_value(): bool; + constructor(); + } + export class CharResult { + get_value(): any; + constructor(); + } + export class IntResult { + get_value(): number; + constructor(); + } + export class DoubleResult { + get_value(): number; + constructor(); + } + export class StringResult { + get_value(): string; + constructor(); + } + export class DateTimeResult { + get_value(): Date; + constructor(); + } + export class GuidResult { + get_value(): SP.Guid; + constructor(); + } + export class JsonObjectResult { + get_value(): any; + constructor(); + } + export class ClientDictionaryResultHandler { + constructor(dict: SP.ClientResult); + } + export class ClientUtility { + static urlPathEncodeForXmlHttpRequest(url: string): string; + static getOrCreateObjectPathForConstructor(context: SP.ClientRuntimeContext, typeId: string, args: any[]): SP.ObjectPath; + } + export class XElement { + get_name(): string; + set_name(value: string): void; + get_attributes(): any; + set_attributes(value: any): void; + get_children(): any; + set_children(value: any): void; + constructor(); + } + export class ClientXElement { + get_element(): SP.XElement; + set_element(value: SP.XElement): void; + constructor(); + } + export class ClientXDocument { + get_root(): SP.XElement; + set_root(value: SP.XElement): void; + constructor(); + } + export class DataConvert { + static writePropertiesToXml(writer: SP.XmlWriter, obj: any, propNames: string[], serializationContext: SP.SerializationContext): void; + static populateDictionaryFromObject(dict: any, parentNode: any): void; + static fixupTypes(context: SP.ClientRuntimeContext, dict: any): void; + static populateArray(context: SP.ClientRuntimeContext, dest: any, jsonArrayFromServer: any): void; + static fixupType(context: SP.ClientRuntimeContext, obj: any): any; + static writeDictionaryToXml(writer: SP.XmlWriter, dict: any, topLevelElementTagName: string, keys: any, serializationContext: SP.SerializationContext): void; + static writeValueToXmlElement(writer: SP.XmlWriter, objValue: any, serializationContext: SP.SerializationContext): void; + static invokeSetProperty(obj: any, propName: string, propValue: any): void; + static invokeGetProperty(obj: any, propName: string): any; + static specifyDateTimeKind(datetime: Date, kind: SP.DateTimeKind): void; + static getDateTimeKind(datetime: Date): SP.DateTimeKind; + static createUnspecifiedDateTime(year: number, month: number, day: number, hour: number, minute: number, second: number, milliseconds: number): Date; + static createUtcDateTime(milliseconds: number): Date; + static createLocalDateTime(milliseconds: number): Date; + } + export interface IWebRequestExecutorFactory { + createWebRequestExecutor(): Sys.Net.WebRequestExecutor; + } + export class PageRequestFailedEventArgs extends Sys.EventArgs { + get_executor(): Sys.Net.WebRequestExecutor; + get_errorMessage(): string; + get_isErrorPage(): bool; + } + export class PageRequestSucceededEventArgs extends Sys.EventArgs { + get_executor(): Sys.Net.WebRequestExecutor; + } + export class PageRequest { + get_request(): Sys.Net.WebRequest; + get_url(): string; + set_url(value: string): void; + get_expectedContentType(): string; + set_expectedContentType(value: string): void; + post(body: string): void; + get (): void; + static doPost(url: string, body: string, expectedContentType: string, succeededHandler: (sender: any, args: SP.PageRequestSucceededEventArgs) => void , failedHandler: (sender: any, args: SP.PageRequestFailedEventArgs) => void ): void; + static doGet(url: string, expectedContentType: string, succeededHandler: (sender: any, args: SP.PageRequestSucceededEventArgs) => void , failedHandler: (sender: any, args: SP.PageRequestFailedEventArgs) => void ): void; + add_succeeded(value: (sender: any, args: SP.PageRequestSucceededEventArgs) => void ): void; + remove_succeeded(value: (sender: any, args: SP.PageRequestSucceededEventArgs) => void ): void; + add_failed(value: (sender: any, args: SP.PageRequestFailedEventArgs) => void ): void; + remove_failed(value: (sender: any, args: SP.PageRequestFailedEventArgs) => void ): void; + constructor(); + } + export class ResResources { + static getString(resourceId: string, args: any[]): string; + } + /** Defines a writer that provides a set of methods to append text in XML format. Use the static SP.XmlWriter.create(sb) Method to create an SP.XmlWriter object with the Sys.StringBuilder object you pass in. */ + export class XmlWriter { + /** Creates a new instance of the XmlWriter class with the specified string builder. */ + static create(sb: Sys.StringBuilder): SP.XmlWriter; + /** Appends a start element tag with the specified name in XML format to the object?s string builder. */ + writeStartElement(tagName: string): void; + /** Appends an element with the specified tag name and value in XML format to the string builder. */ + writeElementString(tagName: string, value: string): void; + /** Appends an end element tag in XML format to the object?s string builder. This method appends the end element tag ?/>? if the start element tag is not closed; otherwise, it appends a full end element tag ?? to the string builder. */ + writeEndElement(): void; + /** Appends an attribute with the specified name and value in XML format to the object?s string builder. */ + writeAttributeString(localName: string, value: string): void; + /** This method only appends the name of the attribute. You can append the value of the attribute by calling the SP.XmlWriter.writeString(value) Method, and close the attribute by calling the SP.XmlWriter.writeEndAttribute() Method. */ + writeStartAttribute(localName: string): void; + /** Appends an end of an attribute in XML format to the object?s string builder. */ + writeEndAttribute(): void; + /** Appends the specified value for an element tag or attribute to the object?s string builder. */ + writeString(value: string): void; + /** Appends the specified text to the object?s string builder. */ + writeRaw(xml: string): void; + /** This member is reserved for internal use and is not intended to be used directly from your code. */ + close(): void; + } + + export class ClientConstants { + AddExpandoFieldTypeSuffix: string; + Actions: string; + ApplicationName: string; + Body: string; + CatchScope: string; + ChildItemQuery: string; + ChildItems: string; + ConditionalScope: string; + Constructor: string; + Context: string; + ErrorInfo: string; + ErrorMessage: string; + ErrorStackTrace: string; + ErrorCode: string; + ErrorTypeName: string; + ErrorValue: string; + ErrorDetails: string; + ErrorTraceCorrelationId: string; + ExceptionHandlingScope: string; + ExceptionHandlingScopeSimple: string; + QueryableExpression: string; + FinallyScope: string; + HasException: string; + Id: string; + Identity: string; + IfFalseScope: string; + IfTrueScope: string; + IsNull: string; + LibraryVersion: string; + TraceCorrelationId: string; + Count: string; + Method: string; + Methods: string; + Name: string; + Object: string; + ObjectPathId: string; + ObjectPath: string; + ObjectPaths: string; + ObjectType: string; + ObjectIdentity: string; + ObjectIdentityQuery: string; + ObjectVersion: string; + Parameter: string; + Parameters: string; + ParentId: string; + Processed: string; + Property: string; + Properties: string; + Query: string; + QueryResult: string; + Request: string; + Results: string; + ScalarProperty: string; + SchemaVersion: string; + ScopeId: string; + SelectAll: string; + SelectAllProperties: string; + SetProperty: string; + SetStaticProperty: string; + StaticMethod: string; + StaticProperty: string; + SuffixChar: string; + SuffixByte: string; + SuffixInt16: string; + SuffixUInt16: string; + SuffixInt32: string; + SuffixUInt32: string; + SuffixInt64: string; + SuffixUInt64: string; + SuffixSingle: string; + SuffixDouble: string; + SuffixDecimal: string; + SuffixTimeSpan: string; + SuffixArray: string; + Test: string; + TryScope: string; + Type: string; + TypeId: string; + Update: string; + Version: string; + XmlElementName: string; + XmlElementAttributes: string; + XmlElementChildren: string; + XmlNamespace: string; + FieldValuesMethodName: string; + RequestTokenHeader: string; + FormDigestHeader: string; + useWebLanguageHeader: string; + useWebLanguageHeaderValue: string; + ClientTagHeader: string; + TraceCorrelationIdRequestHeader: string; + TraceCorrelationIdResponseHeader: string; + greaterThan: string; + lessThan: string; + equal: string; + notEqual: string; + greaterThanOrEqual: string; + lessThanOrEqual: string; + andAlso: string; + orElse: string; + not: string; + expressionParameter: string; + expressionProperty: string; + expressionStaticProperty: string; + expressionMethod: string; + expressionStaticMethod: string; + expressionConstant: string; + expressionConvert: string; + expressionTypeIs: string; + ofType: string; + take: string; + where: string; + orderBy: string; + orderByDescending: string; + thenBy: string; + thenByDescending: string; + queryableObject: string; + ServiceFileName: string; + ServiceMethodName: string; + fluidApplicationInitParamUrl: string; + fluidApplicationInitParamViaUrl: string; + fluidApplicationInitParamRequestToken: string; + fluidApplicationInitParamFormDigestTimeoutSeconds: string; + fluidApplicationInitParamFormDigest: string; + + } + export class ClientSchemaVersions { + version14: string; + version15: string; + currentVersion: string; + } + export class ClientErrorCodes { + genericError: number; + accessDenied: number; + docAlreadyExists: number; + versionConflict: number; + listItemDeleted: number; + invalidFieldValue: number; + notSupported: number; + redirect: number; + notSupportedRequestVersion: number; + fieldValueFailedValidation: number; + itemValueFailedValidation: number; + } + export class ClientAction { + get_id(): number; + get_path(): SP.ObjectPath; + get_name(): string; + } + export class ClientActionSetProperty extends SP.ClientAction { + constructor(obj: SP.ClientObject, propName: string, propValue: any); + } + export class ClientActionSetStaticProperty extends SP.ClientAction { + constructor(context: SP.ClientRuntimeContext, typeId: string, propName: string, propValue: any); + } + export class ClientActionInvokeMethod extends SP.ClientAction { + constructor(obj: SP.ClientObject, methodName: string, parameters: any[]); + } + export class ClientActionInvokeStaticMethod extends SP.ClientAction { + constructor(context: SP.ClientRuntimeContext, typeId: string, methodName: string, parameters: any[]); + } + export class ClientObject { + get_context(): SP.ClientRuntimeContext; + get_path(): SP.ObjectPath; + get_objectVersion(): string; + set_objectVersion(value: string): void; + fromJson(initValue: any): void; + customFromJson(initValue: any): bool; + retrieve(): void; + refreshLoad(): void; + retrieve(propertyNames: string[]): void; + isPropertyAvailable(propertyName: string): bool; + isObjectPropertyInstantiated(propertyName: string): bool; + get_serverObjectIsNull(): bool; + get_typedObject(): SP.ClientObject; + } + export class ClientObjectData { + get_properties(): any; + get_clientObjectProperties(): any; + get_methodReturnObjects(): any; + constructor(); + } + /** Provides a base class for a collection of objects on a remote client. */ + export class ClientObjectCollection extends SP.ClientObject implements IEnumerable { + get_areItemsAvailable(): bool; + /** Gets the data for all of the items in the collection. */ + retrieveItems(): SP.ClientObjectPrototype; + /** Returns an enumerator that iterates through the collection. */ + getEnumerator(): IEnumerator; + /** Returns number of items in the collection. */ + get_count(): number; + get_data(): T[]; + addChild(obj: T): void; + getItemAtIndex(index: number): T; + fromJson(obj: any): void; + } + export class ClientObjectList extends SP.ClientObjectCollection { + constructor(context: SP.ClientRuntimeContext, objectPath: SP.ObjectPath, childItemType: any); + fromJson(initValue: any): void; + customFromJson(initValue: any): bool; + } + export class ClientObjectPrototype { + retrieve(): void; + retrieve(propertyNames: string[]): void; + retrieveObject(propertyName: string): SP.ClientObjectPrototype; + retrieveCollectionObject(propertyName: string): SP.ClientObjectCollectionPrototype; + } + export class ClientObjectCollectionPrototype extends SP.ClientObjectPrototype { + retrieveItems(): SP.ClientObjectPrototype; + } + export enum ClientRequestStatus { + active, + inProgress, + completedSuccess, + completedException, + } + export class WebRequestEventArgs extends Sys.EventArgs { + constructor(webRequest: Sys.Net.WebRequest); + get_webRequest(): Sys.Net.WebRequest; + } + export class ClientRequest { + static get_nextSequenceId(): number; + get_webRequest(): Sys.Net.WebRequest; + add_requestSucceeded(value: (sender: any, args: SP.ClientRequestSucceededEventArgs) => void ): void; + remove_requestSucceeded(value: (sender: any, args: SP.ClientRequestSucceededEventArgs) => void ): void; + add_requestFailed(value: (sender: any, args: SP.ClientRequestFailedEventArgs) => void ): void; + remove_requestFailed(value: (sender: any, args: SP.ClientRequestFailedEventArgs) => void ): void; + get_navigateWhenServerRedirect(): bool; + set_navigateWhenServerRedirect(value: bool): void; + } + export class ClientRequestEventArgs extends Sys.EventArgs { + get_request(): SP.ClientRequest; + } + export class ClientRequestFailedEventArgs extends SP.ClientRequestEventArgs { + constructor(request: SP.ClientRequest, message: string, stackTrace: string, errorCode: number, errorValue: string, errorTypeName: string, errorDetails: any); + constructor(request: SP.ClientRequest, message: string, stackTrace: string, errorCode: number, errorValue: string, errorTypeName: string, errorDetails: any, errorTraceCorrelationId: string); + get_message(): string; + get_stackTrace(): string; + get_errorCode(): number; + get_errorValue(): string; + get_errorTypeName(): string; + get_errorDetails(): any; + get_errorTraceCorrelationId(): string; + } + export class ClientRequestSucceededEventArgs extends SP.ClientRequestEventArgs { + } + export class ClientRuntimeContext implements Sys.IDisposable { + constructor(serverRelativeUrlOrFullUrl: string); + get_url(): string; + get_viaUrl(): string; + set_viaUrl(value: string): void; + get_formDigestHandlingEnabled(): bool; + set_formDigestHandlingEnabled(value: bool): void; + get_applicationName(): string; + set_applicationName(value: string): void; + get_clientTag(): string; + set_clientTag(value: string): void; + get_webRequestExecutorFactory(): SP.IWebRequestExecutorFactory; + set_webRequestExecutorFactory(value: SP.IWebRequestExecutorFactory): void; + get_pendingRequest(): SP.ClientRequest; + get_hasPendingRequest(): bool; + add_executingWebRequest(value: (sender: any, args: SP.WebRequestEventArgs) => void ): void; + remove_executingWebRequest(value: (sender: any, args: SP.WebRequestEventArgs) => void ): void; + add_requestSucceeded(value: (sender: any, args: SP.ClientRequestSucceededEventArgs) => void ): void; + remove_requestSucceeded(value: (sender: any, args: SP.ClientRequestSucceededEventArgs) => void ): void; + add_requestFailed(value: (sender: any, args: SP.ClientRequestFailedEventArgs) => void ): void; + remove_requestFailed(value: (sender: any, args: SP.ClientRequestFailedEventArgs) => void ): void; + add_beginningRequest(value: (sender: any, args: SP.ClientRequestEventArgs) => void ): void; + remove_beginningRequest(value: (sender: any, args: SP.ClientRequestEventArgs) => void ): void; + get_requestTimeout(): number; + set_requestTimeout(value: number): void; + executeQueryAsync(succeededCallback: (sender: any, args: SP.ClientRequestSucceededEventArgs) => void , failedCallback: (sender: any, args: SP.ClientRequestFailedEventArgs) => void ): void; + executeQueryAsync(succeededCallback: (sender: any, args: SP.ClientRequestSucceededEventArgs) => void ): void; + executeQueryAsync(): void; + get_staticObjects(): any; + castTo(obj: SP.ClientObject, type: any): SP.ClientObject; + addQuery(query: SP.ClientAction): void; + addQueryIdAndResultObject(id: number, obj: any): void; + parseObjectFromJsonString(json: string): any; + parseObjectFromJsonString(json: string, skipTypeFixup: bool): any; + load(clientObject: SP.ClientObject): void; + loadQuery(clientObjectCollection: SP.ClientObjectCollection, exp: string): any; + load(clientObject: SP.ClientObject, ...exps: string[]): void; + loadQuery(clientObjectCollection: SP.ClientObjectCollection): any; + get_serverSchemaVersion(): string; + get_serverLibraryVersion(): string; + get_traceCorrelationId(): string; + set_traceCorrelationId(value: string): void; + dispose(): void; + } + export class SimpleDataTable { + get_rows(): any[]; + constructor(); + } + export class ClientValueObject { + fromJson(obj: any): void; + customFromJson(obj: any): bool; + writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; + customWriteToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): bool; + get_typeId(): string; + } + export class ClientValueObjectCollection extends SP.ClientValueObject implements IEnumerable { + get_count(): number; + getEnumerator(): IEnumerator; + writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; + } + export class ExceptionHandlingScope { + constructor(context: SP.ClientRuntimeContext); + startScope(): any; + startTry(): any; + startCatch(): any; + startFinally(): any; + get_processed(): bool; + get_hasException(): bool; + get_errorMessage(): string; + get_serverStackTrace(): string; + get_serverErrorCode(): number; + get_serverErrorValue(): string; + get_serverErrorTypeName(): string; + get_serverErrorDetails(): any; + } + export class ObjectIdentityQuery extends SP.ClientAction { + constructor(objectPath: SP.ObjectPath); + } + export class ObjectPath { + setPendingReplace(): void; + } + export class ObjectPathProperty extends SP.ObjectPath { + constructor(context: SP.ClientRuntimeContext, parent: SP.ObjectPath, propertyName: string); + } + export class ObjectPathStaticProperty extends SP.ObjectPath { + constructor(context: SP.ClientRuntimeContext, typeId: string, propertyName: string); + } + export class ObjectPathMethod extends SP.ObjectPath { + constructor(context: SP.ClientRuntimeContext, parent: SP.ObjectPath, methodName: string, parameters: any[]); + } + export class ObjectPathStaticMethod extends SP.ObjectPath { + constructor(context: SP.ClientRuntimeContext, typeId: string, methodName: string, parameters: any[]); + } + export class ObjectPathConstructor extends SP.ObjectPath { + constructor(context: SP.ClientRuntimeContext, typeId: string, parameters: any[]); + } + export class SerializationContext { + addClientObject(obj: SP.ClientObject): void; + addObjectPath(path: SP.ObjectPath): void; + } + export class ResourceStrings { + argumentExceptionMessage: string; + argumentNullExceptionMessage: string; + cC_AppIconAlt: string; + cC_AppWebUrlNotSet: string; + cC_ArrowImageAlt: string; + cC_BackToSite: string; + cC_ErrorGettingThemeInfo: string; + cC_HelpLinkToolTip: string; + cC_HostSiteUrlNotSet: string; + cC_InvalidArgument: string; + cC_InvalidJSON: string; + cC_InvalidOperation: string; + cC_PlaceHolderElementNotFound: string; + cC_RequiredScriptNotLoaded: string; + cC_SendFeedback: string; + cC_SettingsLinkToolTip: string; + cC_TimeoutGettingThemeInfo: string; + cC_Welcome: string; + cannotFindContextWebServerRelativeUrl: string; + collectionHasNotBeenInitialized: string; + collectionModified: string; + invalidUsageOfConditionalScope: string; + invalidUsageOfConditionalScopeNowAllowedAction: string; + invalidUsageOfExceptionHandlingScope: string; + namedPropertyHasNotBeenInitialized: string; + namedServerObjectIsNull: string; + noObjectPathAssociatedWithObject: string; + notSameClientContext: string; + notSupportedQueryExpressionWithExpressionDetail: string; + objectNameIdentity: string; + objectNameMethod: string; + objectNameProperty: string; + objectNameType: string; + propertyHasNotBeenInitialized: string; + rE_BrowserBinaryDataNotSupported: string; + rE_BrowserNotSupported: string; + rE_CannotAccessSite: string; + rE_CannotAccessSiteCancelled: string; + rE_CannotAccessSiteOpenWindowFailed: string; + rE_DismissOpenWindowMessageLinkText: string; + rE_DomainDoesNotMatch: string; + rE_FixitHelpMessage: string; + rE_InvalidArgumentOrField: string; + rE_InvalidOperation: string; + rE_NoTrustedOrigins: string; + rE_OpenWindowButtonText: string; + rE_OpenWindowMessage: string; + rE_RequestAbortedOrTimedout: string; + rE_RequestUnexpectedResponse: string; + rE_RequestUnexpectedResponseWithContentTypeAndStatus: string; + requestAbortedOrTimedOut: string; + requestEmptyQueryName: string; + requestHasBeenExecuted: string; + requestUnexpectedResponse: string; + requestUnexpectedResponseWithContentTypeAndStatus: string; + requestUnexpectedResponseWithStatus: string; + requestUnknownResponse: string; + serverObjectIsNull: string; + unknownError: string; + unknownResponseData: string; + } + export class RuntimeRes { + cC_PlaceHolderElementNotFound: string; + rE_CannotAccessSiteOpenWindowFailed: string; + noObjectPathAssociatedWithObject: string; + cC_TimeoutGettingThemeInfo: string; + unknownResponseData: string; + requestUnexpectedResponseWithStatus: string; + objectNameProperty: string; + requestUnknownResponse: string; + rE_RequestUnexpectedResponseWithContentTypeAndStatus: string; + rE_BrowserNotSupported: string; + argumentExceptionMessage: string; + namedServerObjectIsNull: string; + objectNameType: string; + requestUnexpectedResponseWithContentTypeAndStatus: string; + cC_InvalidJSON: string; + invalidUsageOfExceptionHandlingScope: string; + serverObjectIsNull: string; + cC_AppWebUrlNotSet: string; + rE_OpenWindowMessage: string; + argumentNullExceptionMessage: string; + cC_HelpLinkToolTip: string; + propertyHasNotBeenInitialized: string; + rE_RequestAbortedOrTimedout: string; + invalidUsageOfConditionalScope: string; + cC_ErrorGettingThemeInfo: string; + rE_DismissOpenWindowMessageLinkText: string; + rE_CannotAccessSiteCancelled: string; + objectNameIdentity: string; + cC_HostSiteUrlNotSet: string; + rE_FixitHelpMessage: string; + notSupportedQueryExpressionWithExpressionDetail: string; + rE_RequestUnexpectedResponse: string; + rE_DomainDoesNotMatch: string; + cC_BackToSite: string; + rE_NoTrustedOrigins: string; + rE_InvalidOperation: string; + collectionModified: string; + cC_Welcome: string; + cC_AppIconAlt: string; + cC_SendFeedback: string; + cC_ArrowImageAlt: string; + cC_InvalidOperation: string; + requestAbortedOrTimedOut: string; + invalidUsageOfConditionalScopeNowAllowedAction: string; + cannotFindContextWebServerRelativeUrl: string; + rE_OpenWindowButtonText: string; + unknownError: string; + cC_InvalidArgument: string; + rE_InvalidArgumentOrField: string; + cC_SettingsLinkToolTip: string; + requestEmptyQueryName: string; + cC_RequiredScriptNotLoaded: string; + rE_CannotAccessSite: string; + notSameClientContext: string; + requestUnexpectedResponse: string; + rE_BrowserBinaryDataNotSupported: string; + collectionHasNotBeenInitialized: string; + namedPropertyHasNotBeenInitialized: string; + requestHasBeenExecuted: string; + objectNameMethod: string; + } + export class ParseJSONUtil { + static parseObjectFromJsonString(json: string): any; + static validateJson(text: string): bool; + } + export enum DateTimeKind { + unspecified, + utc, + local, + } + export class OfficeVersion { + majorBuildVersion: number; + previousMajorBuildVersion: number; + majorVersion: string; + previousVersion: string; + majorVersionDotZero: string; + previousVersionDotZero: string; + assemblyVersion: string; + wssMajorVersion: string; + } + export class ClientContext extends SP.ClientRuntimeContext { + constructor(serverRelativeUrlOrFullUrl: string); + static get_current(): SP.ClientContext; + constructor(); + get_web(): SP.Web; + get_site(): SP.Site; + get_serverVersion(): string; + } + export enum ULSTraceLevel { + verbose, + } + /** Provides a Unified Logging Service (ULS) that monitors log messages. */ + export class ULS { + /** Gets a value that indicates whether the Unified Logging Service (ULS) is enabled. */ + static get_enabled(): bool; + /** Sets a value that indicates whether the Unified Logging Service (ULS) is enabled. */ + static set_enabled(value: bool): void; + /** Logs the specified debug message. + This method logs the message with a time stamp. If any log messages are pending, this method also logs them. If the message cannot be logged, the message is added to the list of pending log messages. */ + static log(debugMessage: string): void; + /** Increases the indentation for subsequent log messages. */ + static increaseIndent(): void; + /** Decreases the indentation for subsequent log messages. */ + static decreaseIndent(): void; + /** Traces when the function was entered. */ + static traceApiEnter(functionName: string, args: any[]): void; + /** Traces when the function was entered. */ + static traceApiEnter(functionName: string): void; + /** Traces when the function has finished. */ + static traceApiLeave(): void; + } + export class AccessRequests { + static changeRequestStatus(context: SP.ClientRuntimeContext, itemId: number, newStatus: number, convStr: string, permType: string, permissionLevel: number): void; + static changeRequestStatusBulk(context: SP.ClientRuntimeContext, requestIds: number[], newStatus: number): void; + } + export enum AddFieldOptions { + defaultValue, + addToDefaultContentType, + addToNoContentType, + addToAllContentTypes, + addFieldInternalNameHint, + addFieldToDefaultView, + addFieldCheckDisplayName, + } + export class AlternateUrl extends SP.ClientObject { + get_uri(): string; + get_urlZone(): SP.UrlZone; + } + export class App extends SP.ClientObject { + get_assetId(): string; + get_contentMarket(): string; + get_versionString(): string; + } + export class AppCatalog { + static getAppInstances(context: SP.ClientRuntimeContext, web: SP.Web): SP.ClientObjectList; + static getDeveloperSiteAppInstancesByIds(context: SP.ClientRuntimeContext, site: SP.Site, appInstanceIds: SP.Guid[]): SP.ClientObjectList; + static isAppSideloadingEnabled(context: SP.ClientRuntimeContext): SP.BooleanResult; + } + export class AppContextSite extends SP.ClientObject { + constructor(context: SP.ClientRuntimeContext, siteUrl: string); + get_site(): SP.Site; + get_web(): SP.Web; + static newObject(context: SP.ClientRuntimeContext, siteUrl: string): SP.AppContextSite; + } + export class AppInstance extends SP.ClientObject { + get_appPrincipalId(): string; + get_appWebFullUrl(): string; + get_id(): SP.Guid; + get_inError(): bool; + get_startPage(): string; + get_remoteAppUrl(): string; + get_settingsPageUrl(): string; + get_siteId(): SP.Guid; + get_status(): SP.AppInstanceStatus; + get_title(): string; + get_webId(): SP.Guid; + getErrorDetails(): SP.ClientObjectList; + uninstall(): SP.GuidResult; + upgrade(appPackageStream: any[]): void; + cancelAllJobs(): SP.BooleanResult; + install(): SP.GuidResult; + getPreviousAppVersion(): SP.App; + retryAllJobs(): void; + } + export class AppInstanceErrorDetails extends SP.ClientObject { + get_correlationId(): SP.Guid; + set_correlationId(value: SP.Guid): void; + get_errorDetail(): string; + get_errorType(): SP.AppInstanceErrorType; + set_errorType(value: SP.AppInstanceErrorType): void; + get_errorTypeName(): string; + get_exceptionMessage(): string; + get_source(): SP.AppInstanceErrorSource; + set_source(value: SP.AppInstanceErrorSource): void; + get_sourceName(): string; + } + export enum AppInstanceErrorSource { + common, + appWeb, + parentWeb, + remoteWebSite, + database, + officeExtension, + eventCallouts, + finalization, + } + export enum AppInstanceErrorType { + transient, + configuration, + app, + } + export enum AppInstanceStatus { + invalidStatus, + installing, + canceling, + uninstalling, + installed, + upgrading, + initialized, + upgradeCanceling, + disabling, + disabled, + } + export class AppLicense extends SP.ClientValueObject { + get_rawXMLLicenseToken(): string; + get_typeId(): string; + writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; + constructor(); + } + export class AppLicenseCollection extends SP.ClientValueObjectCollection { + add(item: SP.AppLicense): void; + get_item(index: number): SP.AppLicense; + get_typeId(): string; + writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; + constructor(); + } + export enum AppLicenseType { + perpetualMultiUser, + perpetualAllUsers, + trialMultiUser, + trialAllUsers, + } + export class Attachment extends SP.ClientObject { + get_fileName(): string; + get_serverRelativeUrl(): string; + deleteObject(): void; + } + export class AttachmentCollection extends SP.ClientObjectCollection { + itemAt(index: number): SP.Attachment; + get_item(index: number): SP.Attachment; + getByFileName(fileName: string): SP.Attachment; + } + export class AttachmentCreationInformation extends SP.ClientValueObject { + get_contentStream(): any[]; + set_contentStream(value: any[]): void; + get_fileName(): string; + set_fileName(value: string): void; + get_typeId(): string; + writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; + constructor(); + } + export class BasePermissions extends SP.ClientValueObject { + set (perm: SP.PermissionKind): void; + clear(perm: SP.PermissionKind): void; + clearAll(): void; + has(perm: SP.PermissionKind): bool; + equals(perm: SP.BasePermissions): bool; + hasPermissions(high: number, low: number): bool; + get_typeId(): string; + writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; + constructor(); + } + /** Specifies the base type for a list. */ + export enum BaseType { + none, + genericList, + documentLibrary, + unused, + discussionBoard, + survey, + issue, + } + export enum BrowserFileHandling { + permissive, + strict, + } + export enum CalendarType { + none, + gregorian, + japan, + taiwan, + korea, + hijri, + thai, + hebrew, + gregorianMEFrench, + gregorianArabic, + gregorianXLITEnglish, + gregorianXLITFrench, + koreaJapanLunar, + chineseLunar, + sakaEra, + umAlQura, + } + /** Specifies a Collaborative Application Markup Language (CAML) query on a list. */ + export class CamlQuery extends SP.ClientValueObject { + constructor(); + /** This method creates a Collaborative Application Markup Language (CAML) string + that can be used to recursively get all of the items in a list, including + the items in the subfolders. */ + static createAllItemsQuery(): SP.CamlQuery; + /** This method creates a Collaborative Application Markup Language (CAML) string + that can be used to recursively get all of the folders in a list, including + the subfolders. */ + static createAllFoldersQuery(): SP.CamlQuery; + /** Returns true if the query returns dates in Coordinated Universal Time (UTC) format. */ + get_datesInUtc(): bool; + /** Sets a value that indicates whether the query returns dates in Coordinated Universal Time (UTC) format. */ + set_datesInUtc(value: bool): void; + /** Server relative URL of a list folder from which results will be returned. */ + get_folderServerRelativeUrl(): string; + /** Sets a value that specifies the server relative URL of a list folder from which results will be returned. */ + set_folderServerRelativeUrl(value: string): void; + get_listItemCollectionPosition(): SP.ListItemCollectionPosition; + /** Sets a value that specifies the information required to get the next page of data for the list view. */ + set_listItemCollectionPosition(value: SP.ListItemCollectionPosition): void; + /** Gets value that specifies the XML schema that defines the list view. */ + get_viewXml(): string; + /** Sets value that specifies the XML schema that defines the list view. It must be null, empty, or an XML fragment that conforms to the ViewDefinition type. */ + set_viewXml(value: string): void; + /** This member is reserved for internal use and is not intended to be used directly from your code. */ + get_typeId(): string; + writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; + } + export class Change extends SP.ClientObject { + get_changeToken(): SP.ChangeToken; + get_changeType(): SP.ChangeType; + get_siteId(): SP.Guid; + get_time(): Date; + } + export class ChangeAlert extends SP.Change { + get_alertId(): SP.Guid; + get_webId(): SP.Guid; + } + export class ChangeCollection extends SP.ClientObjectCollection { + itemAt(index: number): SP.Change; + get_item(index: number): SP.Change; + } + export class ChangeContentType extends SP.Change { + get_contentTypeId(): SP.ContentTypeId; + get_webId(): SP.Guid; + } + export class ChangeField extends SP.Change { + get_fieldId(): SP.Guid; + get_webId(): SP.Guid; + } + export class ChangeFile extends SP.Change { + get_uniqueId(): SP.Guid; + get_webId(): SP.Guid; + } + export class ChangeFolder extends SP.Change { + get_uniqueId(): SP.Guid; + get_webId(): SP.Guid; + } + export class ChangeGroup extends SP.Change { + get_groupId(): number; + } + export class ChangeItem extends SP.Change { + get_itemId(): number; + get_listId(): SP.Guid; + get_webId(): SP.Guid; + } + export class ChangeList extends SP.Change { + get_listId(): SP.Guid; + get_webId(): SP.Guid; + } + export class ChangeLogItemQuery extends SP.ClientValueObject { + get_changeToken(): string; + set_changeToken(value: string): void; + get_contains(): string; + set_contains(value: string): void; + get_query(): string; + set_query(value: string): void; + get_queryOptions(): string; + set_queryOptions(value: string): void; + get_rowLimit(): string; + set_rowLimit(value: string): void; + get_viewFields(): string; + set_viewFields(value: string): void; + get_viewName(): string; + set_viewName(value: string): void; + get_typeId(): string; + writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; + constructor(); + } + export class ChangeQuery extends SP.ClientValueObject { + constructor(); + constructor(allChangeObjectTypes: bool, allChangeTypes: bool); + get_add(): bool; + set_add(value: bool): void; + get_alert(): bool; + set_alert(value: bool): void; + get_changeTokenEnd(): SP.ChangeToken; + set_changeTokenEnd(value: SP.ChangeToken): void; + get_changeTokenStart(): SP.ChangeToken; + set_changeTokenStart(value: SP.ChangeToken): void; + get_contentType(): bool; + set_contentType(value: bool): void; + get_deleteObject(): bool; + set_deleteObject(value: bool): void; + get_field(): bool; + set_field(value: bool): void; + get_file(): bool; + set_file(value: bool): void; + get_folder(): bool; + set_folder(value: bool): void; + get_group(): bool; + set_group(value: bool): void; + get_groupMembershipAdd(): bool; + set_groupMembershipAdd(value: bool): void; + get_groupMembershipDelete(): bool; + set_groupMembershipDelete(value: bool): void; + get_item(): bool; + set_item(value: bool): void; + get_list(): bool; + set_list(value: bool): void; + get_move(): bool; + set_move(value: bool): void; + get_navigation(): bool; + set_navigation(value: bool): void; + get_rename(): bool; + set_rename(value: bool): void; + get_restore(): bool; + set_restore(value: bool): void; + get_roleAssignmentAdd(): bool; + set_roleAssignmentAdd(value: bool): void; + get_roleAssignmentDelete(): bool; + set_roleAssignmentDelete(value: bool): void; + get_roleDefinitionAdd(): bool; + set_roleDefinitionAdd(value: bool): void; + get_roleDefinitionDelete(): bool; + set_roleDefinitionDelete(value: bool): void; + get_roleDefinitionUpdate(): bool; + set_roleDefinitionUpdate(value: bool): void; + get_securityPolicy(): bool; + set_securityPolicy(value: bool): void; + get_site(): bool; + set_site(value: bool): void; + get_systemUpdate(): bool; + set_systemUpdate(value: bool): void; + get_update(): bool; + set_update(value: bool): void; + get_user(): bool; + set_user(value: bool): void; + get_view(): bool; + set_view(value: bool): void; + get_web(): bool; + set_web(value: bool): void; + get_typeId(): string; + writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; + } + export class ChangeSite extends SP.Change { + } + export class ChangeToken extends SP.ClientValueObject { + get_stringValue(): string; + set_stringValue(value: string): void; + get_typeId(): string; + writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; + constructor(); + } + export enum ChangeType { + noChange, + add, + update, + deleteObject, + rename, + moveAway, + moveInto, + restore, + roleAdd, + roleDelete, + roleUpdate, + assignmentAdd, + assignmentDelete, + memberAdd, + memberDelete, + systemUpdate, + navigation, + scopeAdd, + scopeDelete, + listContentTypeAdd, + listContentTypeDelete, + } + export class ChangeUser extends SP.Change { + get_activate(): bool; + get_userId(): number; + } + export class ChangeView extends SP.Change { + get_viewId(): SP.Guid; + get_listId(): SP.Guid; + get_webId(): SP.Guid; + } + export class ChangeWeb extends SP.Change { + get_webId(): SP.Guid; + } + export enum CheckinType { + minorCheckIn, + majorCheckIn, + overwriteCheckIn, + } + export enum CheckOutType { + online, + offline, + none, + } + export enum ChoiceFormatType { + dropdown, + radioButtons, + } + export class CompatibilityRange extends SP.ClientObject { + } + export class ContentType extends SP.ClientObject { + get_description(): string; + set_description(value: string): void; + get_displayFormTemplateName(): string; + set_displayFormTemplateName(value: string): void; + get_displayFormUrl(): string; + set_displayFormUrl(value: string): void; + get_documentTemplate(): string; + set_documentTemplate(value: string): void; + get_documentTemplateUrl(): string; + get_editFormTemplateName(): string; + set_editFormTemplateName(value: string): void; + get_editFormUrl(): string; + set_editFormUrl(value: string): void; + get_fieldLinks(): SP.FieldLinkCollection; + get_fields(): SP.FieldCollection; + get_group(): string; + set_group(value: string): void; + get_hidden(): bool; + set_hidden(value: bool): void; + get_id(): SP.ContentTypeId; + get_jSLink(): string; + set_jSLink(value: string): void; + get_name(): string; + set_name(value: string): void; + get_newFormTemplateName(): string; + set_newFormTemplateName(value: string): void; + get_newFormUrl(): string; + set_newFormUrl(value: string): void; + get_parent(): SP.ContentType; + get_readOnly(): bool; + set_readOnly(value: bool): void; + get_schemaXml(): string; + get_schemaXmlWithResourceTokens(): string; + set_schemaXmlWithResourceTokens(value: string): void; + get_scope(): string; + get_sealed(): bool; + set_sealed(value: bool): void; + get_stringId(): string; + get_workflowAssociations(): SP.Workflow.WorkflowAssociationCollection; + update(updateChildren: bool): void; + deleteObject(): void; + } + export class ContentTypeCollection extends SP.ClientObjectCollection { + itemAt(index: number): SP.ContentType; + get_item(index: number): SP.ContentType; + getById(contentTypeId: string): SP.ContentType; + addExistingContentType(contentType: SP.ContentType): SP.ContentType; + add(parameters: SP.ContentTypeCreationInformation): SP.ContentType; + } + export class ContentTypeCreationInformation extends SP.ClientValueObject { + get_description(): string; + set_description(value: string): void; + get_group(): string; + set_group(value: string): void; + get_name(): string; + set_name(value: string): void; + get_parentContentType(): SP.ContentType; + set_parentContentType(value: SP.ContentType): void; + get_typeId(): string; + writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; + constructor(); + } + export class ContentTypeId extends SP.ClientValueObject { + toString(): string; + get_stringValue(): string; + get_typeId(): string; + writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; + constructor(); + } + export enum CustomizedPageStatus { + none, + uncustomized, + customized, + } + export enum DateTimeFieldFormatType { + dateOnly, + dateTime, + } + export enum DateTimeFieldFriendlyFormatType { + unspecified, + disabled, + relative, + } + export enum DraftVisibilityType { + reader, + author, + approver, + } + export class EventReceiverDefinition extends SP.ClientObject { + get_receiverAssembly(): string; + get_receiverClass(): string; + get_receiverId(): SP.Guid; + get_receiverName(): string; + get_sequenceNumber(): number; + get_synchronization(): SP.EventReceiverSynchronization; + get_eventType(): SP.EventReceiverType; + get_receiverUrl(): string; + update(): void; + deleteObject(): void; + } + export class EventReceiverDefinitionCollection extends SP.ClientObjectCollection { + itemAt(index: number): SP.EventReceiverDefinition; + get_item(index: number): SP.EventReceiverDefinition; + getById(eventReceiverId: SP.Guid): SP.EventReceiverDefinition; + add(eventReceiverCreationInformation: SP.EventReceiverDefinitionCreationInformation): SP.EventReceiverDefinition; + } + export class EventReceiverDefinitionCreationInformation extends SP.ClientValueObject { + get_receiverAssembly(): string; + set_receiverAssembly(value: string): void; + get_receiverClass(): string; + set_receiverClass(value: string): void; + get_receiverName(): string; + set_receiverName(value: string): void; + get_sequenceNumber(): number; + set_sequenceNumber(value: number): void; + get_synchronization(): SP.EventReceiverSynchronization; + set_synchronization(value: SP.EventReceiverSynchronization): void; + get_eventType(): SP.EventReceiverType; + set_eventType(value: SP.EventReceiverType): void; + get_receiverUrl(): string; + set_receiverUrl(value: string): void; + get_typeId(): string; + writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; + constructor(); + } + export enum EventReceiverSynchronization { + defaultSynchronization, + synchronous, + asynchronous, + } + export enum EventReceiverType { + invalidReceiver, + itemAdding, + itemUpdating, + itemDeleting, + itemCheckingIn, + itemCheckingOut, + itemUncheckingOut, + itemAttachmentAdding, + itemAttachmentDeleting, + itemFileMoving, + itemVersionDeleting, + fieldAdding, + fieldUpdating, + fieldDeleting, + listAdding, + listDeleting, + siteDeleting, + webDeleting, + webMoving, + webAdding, + groupAdding, + groupUpdating, + groupDeleting, + groupUserAdding, + groupUserDeleting, + roleDefinitionAdding, + roleDefinitionUpdating, + roleDefinitionDeleting, + roleAssignmentAdding, + roleAssignmentDeleting, + inheritanceBreaking, + inheritanceResetting, + workflowStarting, + itemAdded, + itemUpdated, + itemDeleted, + itemCheckedIn, + itemCheckedOut, + itemUncheckedOut, + itemAttachmentAdded, + itemAttachmentDeleted, + itemFileMoved, + itemFileConverted, + itemVersionDeleted, + fieldAdded, + fieldUpdated, + fieldDeleted, + listAdded, + listDeleted, + siteDeleted, + webDeleted, + webMoved, + webProvisioned, + groupAdded, + groupUpdated, + groupDeleted, + groupUserAdded, + groupUserDeleted, + roleDefinitionAdded, + roleDefinitionUpdated, + roleDefinitionDeleted, + roleAssignmentAdded, + roleAssignmentDeleted, + inheritanceBroken, + inheritanceReset, + workflowStarted, + workflowPostponed, + workflowCompleted, + entityInstanceAdded, + entityInstanceUpdated, + entityInstanceDeleted, + appInstalled, + appUpgraded, + appUninstalling, + emailReceived, + contextEvent, + } + export class Feature extends SP.ClientObject { + get_definitionId(): SP.Guid; + } + export class FeatureCollection extends SP.ClientObjectCollection { + itemAt(index: number): SP.Feature; + get_item(index: number): SP.Feature; + getById(featureId: SP.Guid): SP.Feature; + add(featureId: SP.Guid, force: bool, featdefScope: SP.FeatureDefinitionScope): SP.Feature; + remove(featureId: SP.Guid, force: bool): void; + } + export enum FeatureDefinitionScope { + none, + farm, + site, + web, + } + export class Field extends SP.ClientObject { + get_canBeDeleted(): bool; + get_defaultValue(): string; + set_defaultValue(value: string): void; + get_description(): string; + set_description(value: string): void; + get_direction(): string; + set_direction(value: string): void; + get_enforceUniqueValues(): bool; + set_enforceUniqueValues(value: bool): void; + get_entityPropertyName(): string; + get_filterable(): bool; + get_fromBaseType(): bool; + get_group(): string; + set_group(value: string): void; + get_hidden(): bool; + set_hidden(value: bool): void; + get_id(): SP.Guid; + get_indexed(): bool; + set_indexed(value: bool): void; + get_internalName(): string; + get_jSLink(): string; + set_jSLink(value: string): void; + get_readOnlyField(): bool; + set_readOnlyField(value: bool): void; + get_required(): bool; + set_required(value: bool): void; + get_schemaXml(): string; + set_schemaXml(value: string): void; + get_schemaXmlWithResourceTokens(): string; + get_scope(): string; + get_sealed(): bool; + get_sortable(): bool; + get_staticName(): string; + set_staticName(value: string): void; + get_title(): string; + set_title(value: string): void; + get_fieldTypeKind(): SP.FieldType; + set_fieldTypeKind(value: SP.FieldType): void; + get_typeAsString(): string; + set_typeAsString(value: string): void; + get_typeDisplayName(): string; + get_typeShortDescription(): string; + get_validationFormula(): string; + set_validationFormula(value: string): void; + get_validationMessage(): string; + set_validationMessage(value: string): void; + validateSetValue(item: SP.ListItem, value: string): void; + updateAndPushChanges(pushChangesToLists: bool): void; + update(): void; + deleteObject(): void; + setShowInDisplayForm(value: bool): void; + setShowInEditForm(value: bool): void; + setShowInNewForm(value: bool): void; + } + export class FieldCalculated extends SP.Field { + get_dateFormat(): SP.DateTimeFieldFormatType; + set_dateFormat(value: SP.DateTimeFieldFormatType): void; + get_formula(): string; + set_formula(value: string): void; + get_outputType(): SP.FieldType; + set_outputType(value: SP.FieldType): void; + } + export class FieldCalculatedErrorValue extends SP.ClientValueObject { + get_errorMessage(): string; + get_typeId(): string; + writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; + constructor(); + } + export class FieldMultiChoice extends SP.Field { + get_fillInChoice(): bool; + set_fillInChoice(value: bool): void; + get_mappings(): string; + get_choices(): string[]; + set_choices(value: string[]): void; + } + export class FieldChoice extends SP.FieldMultiChoice { + get_editFormat(): SP.ChoiceFormatType; + set_editFormat(value: SP.ChoiceFormatType): void; + } + export class FieldCollection extends SP.ClientObjectCollection { + itemAt(index: number): SP.Field; + get_item(index: number): SP.Field; + get_schemaXml(): string; + getByTitle(title: string): SP.Field; + getById(id: SP.Guid): SP.Field; + add(field: SP.Field): SP.Field; + addDependentLookup(displayName: string, primaryLookupField: SP.Field, lookupField: string): SP.Field; + addFieldAsXml(schemaXml: string, addToDefaultView: bool, options: SP.AddFieldOptions): SP.Field; + getByInternalNameOrTitle(strName: string): SP.Field; + } + export class FieldComputed extends SP.Field { + get_enableLookup(): bool; + set_enableLookup(value: bool): void; + } + export class FieldNumber extends SP.Field { + get_maximumValue(): number; + set_maximumValue(value: number): void; + get_minimumValue(): number; + set_minimumValue(value: number): void; + } + export class FieldCurrency extends SP.FieldNumber { + get_currencyLocaleId(): number; + set_currencyLocaleId(value: number): void; + } + export class FieldDateTime extends SP.Field { + get_dateTimeCalendarType(): SP.CalendarType; + set_dateTimeCalendarType(value: SP.CalendarType): void; + get_displayFormat(): SP.DateTimeFieldFormatType; + set_displayFormat(value: SP.DateTimeFieldFormatType): void; + get_friendlyDisplayFormat(): SP.DateTimeFieldFriendlyFormatType; + set_friendlyDisplayFormat(value: SP.DateTimeFieldFriendlyFormatType): void; + } + export class FieldGeolocation extends SP.Field { + } + export class FieldGeolocationValue extends SP.ClientValueObject { + get_altitude(): number; + set_altitude(value: number): void; + get_latitude(): number; + set_latitude(value: number): void; + get_longitude(): number; + set_longitude(value: number): void; + get_measure(): number; + set_measure(value: number): void; + get_typeId(): string; + writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; + constructor(); + } + export class FieldGuid extends SP.Field { + } + export class FieldLink extends SP.ClientObject { + get_hidden(): bool; + set_hidden(value: bool): void; + get_id(): SP.Guid; + get_name(): string; + get_required(): bool; + set_required(value: bool): void; + deleteObject(): void; + } + export class FieldLinkCollection extends SP.ClientObjectCollection { + itemAt(index: number): SP.FieldLink; + get_item(index: number): SP.FieldLink; + getById(id: SP.Guid): SP.FieldLink; + add(parameters: SP.FieldLinkCreationInformation): SP.FieldLink; + reorder(internalNames: string[]): void; + } + export class FieldLinkCreationInformation extends SP.ClientValueObject { + get_field(): SP.Field; + set_field(value: SP.Field): void; + get_typeId(): string; + writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; + constructor(); + } + export class FieldLookup extends SP.Field { + get_allowMultipleValues(): bool; + set_allowMultipleValues(value: bool): void; + get_isRelationship(): bool; + set_isRelationship(value: bool): void; + get_lookupField(): string; + set_lookupField(value: string): void; + get_lookupList(): string; + set_lookupList(value: string): void; + get_lookupWebId(): SP.Guid; + set_lookupWebId(value: SP.Guid): void; + get_primaryFieldId(): string; + set_primaryFieldId(value: string): void; + get_relationshipDeleteBehavior(): SP.RelationshipDeleteBehaviorType; + set_relationshipDeleteBehavior(value: SP.RelationshipDeleteBehaviorType): void; + } + export class FieldLookupValue extends SP.ClientValueObject { + get_lookupId(): number; + set_lookupId(value: number): void; + get_lookupValue(): string; + get_typeId(): string; + writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; + constructor(); + } + export class FieldMultiLineText extends SP.Field { + get_allowHyperlink(): bool; + set_allowHyperlink(value: bool): void; + get_appendOnly(): bool; + set_appendOnly(value: bool): void; + get_numberOfLines(): number; + set_numberOfLines(value: number): void; + get_restrictedMode(): bool; + set_restrictedMode(value: bool): void; + get_richText(): bool; + set_richText(value: bool): void; + get_wikiLinking(): bool; + } + export class FieldRatingScale extends SP.FieldMultiChoice { + get_gridEndNumber(): number; + set_gridEndNumber(value: number): void; + get_gridNAOptionText(): string; + set_gridNAOptionText(value: string): void; + get_gridStartNumber(): number; + set_gridStartNumber(value: number): void; + get_gridTextRangeAverage(): string; + set_gridTextRangeAverage(value: string): void; + get_gridTextRangeHigh(): string; + set_gridTextRangeHigh(value: string): void; + get_gridTextRangeLow(): string; + set_gridTextRangeLow(value: string): void; + get_rangeCount(): number; + } + export class FieldRatingScaleQuestionAnswer extends SP.ClientValueObject { + get_answer(): number; + set_answer(value: number): void; + get_question(): string; + set_question(value: string): void; + get_typeId(): string; + writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; + constructor(); + } + export class FieldStringValues extends SP.ClientObject { + get_fieldValues(): any; + get_item(fieldName: string): string; + refreshLoad(): void; + } + export class FieldText extends SP.Field { + get_maxLength(): number; + set_maxLength(value: number): void; + } + export enum FieldType { + invalid, + integer, + text, + note, + dateTime, + counter, + choice, + lookup, + boolean, + number, + currency, + uRL, + computed, + threading, + guid, + multiChoice, + gridChoice, + calculated, + file, + attachments, + user, + recurrence, + crossProjectLink, + modStat, + error, + contentTypeId, + pageSeparator, + threadIndex, + workflowStatus, + allDayEvent, + workflowEventType, + geolocation, + outcomeChoice, + maxItems, + } + export class FieldUrl extends SP.Field { + get_displayFormat(): SP.UrlFieldFormatType; + set_displayFormat(value: SP.UrlFieldFormatType): void; + } + export class FieldUrlValue extends SP.ClientValueObject { + get_description(): string; + set_description(value: string): void; + get_url(): string; + set_url(value: string): void; + get_typeId(): string; + writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; + constructor(); + } + export class FieldUser extends SP.FieldLookup { + get_allowDisplay(): bool; + set_allowDisplay(value: bool): void; + get_presence(): bool; + set_presence(value: bool): void; + get_selectionGroup(): number; + set_selectionGroup(value: number): void; + get_selectionMode(): SP.FieldUserSelectionMode; + set_selectionMode(value: SP.FieldUserSelectionMode): void; + } + export enum FieldUserSelectionMode { + peopleOnly, + peopleAndGroups, + } + export class FieldUserValue extends SP.FieldLookupValue { + static fromUser(userName: string): SP.FieldUserValue; + get_typeId(): string; + writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; + constructor(); + } + /** Represents a file in a SharePoint Web site that can be a Web Part Page, an item in a document library, or a file in a folder. */ + export class File extends SP.ClientObject { + get_author(): SP.User; + /** Returns the user who has checked out the file. */ + get_checkedOutByUser(): SP.User; + /** Returns the comment that was specified when the document was checked into the document library. */ + get_checkInComment(): string; + /** The type of checkout that exists on the document. */ + get_checkOutType(): SP.CheckOutType; + get_contentTag(): string; + /** Gets the customization(ghost) status of the SPFile. */ + get_customizedPageStatus(): SP.CustomizedPageStatus; + /** Gets the ETag of the file */ + get_eTag(): string; + /** Specifies whether the file exists */ + get_exists(): bool; + get_length(): number; + get_level(): SP.FileLevel; + /** Specifies the SPListItem corresponding to this file if this file belongs to a doclib. Values for all fields are returned also. */ + get_listItemAllFields(): SP.ListItem; + /** Returns the user that owns the current lock on the file. MUST return null if there is no lock. */ + get_lockedByUser(): SP.User; + /** Specifies the major version of the file. */ + get_majorVersion(): number; + /** Specifies the minor version of the file. */ + get_minorVersion(): number; + get_modifiedBy(): SP.User; + get_name(): string; + get_serverRelativeUrl(): string; + /** Specifies when the file was created. */ + get_timeCreated(): Date; + /** Specifies when the file was created. */ + get_timeLastModified(): Date; + get_title(): string; + /** Specifies the implementation-specific version identifier of the file. */ + get_uIVersion(): number; + /** Specifies the implementation-specific version identifier of the file. */ + get_uIVersionLabel(): string; + /** Returns a collection of file version objects that represent the versions of the file. */ + get_versions(): SP.FileVersionCollection; + /** Reverts an existing online or offline checkout for the file. */ + undoCheckOut(): void; + checkIn(comment: string, checkInType: SP.CheckinType): void; + publish(comment: string): void; + /** Removes the file from content approval with the specified comment. */ + unPublish(comment: string): void; + /** Approves the file submitted for content approval with the specified comment. */ + approve(comment: string): void; + /** Denies the file submitted for content approval. */ + deny(comment: string): void; + static getContentVerFromTag(context: SP.ClientRuntimeContext, contentTag: string): SP.IntResult; + getLimitedWebPartManager(scope: SP.WebParts.PersonalizationScope): SP.WebParts.LimitedWebPartManager; + moveTo(newUrl: string, flags: SP.MoveOperations): void; + copyTo(strNewUrl: string, bOverWrite: bool): void; + saveBinary(parameters: SP.FileSaveBinaryInformation): void; + deleteObject(): void; + /** Moves the file to the recycle bin. MUST return the identifier of the new Recycle Bin item */ + recycle(): SP.GuidResult; + checkOut(): void; + } + export class FileCollection extends SP.ClientObjectCollection { + itemAt(index: number): SP.File; + get_item(index: number): SP.File; + getByUrl(url: string): SP.File; + add(parameters: SP.FileCreationInformation): SP.File; + addTemplateFile(urlOfFile: string, templateFileType: SP.TemplateFileType): SP.File; + } + export class FileCreationInformation extends SP.ClientValueObject { + get_content(): SP.Base64EncodedByteArray; + set_content(value: SP.Base64EncodedByteArray): void; + get_overwrite(): bool; + set_overwrite(value: bool): void; + get_url(): string; + set_url(value: string): void; + get_typeId(): string; + writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; + constructor(); + } + export enum FileLevel { + published, + draft, + checkout, + } + export class FileSaveBinaryInformation extends SP.ClientValueObject { + get_checkRequiredFields(): bool; + set_checkRequiredFields(value: bool): void; + get_content(): SP.Base64EncodedByteArray; + set_content(value: SP.Base64EncodedByteArray): void; + get_eTag(): string; + set_eTag(value: string): void; + get_fieldValues(): any; + set_fieldValues(value: any): void; + get_typeId(): string; + writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; + constructor(); + } + export enum FileSystemObjectType { + invalid, + file, + folder, + web, + } + export class FileVersion extends SP.ClientObject { + get_checkInComment(): string; + get_created(): Date; + get_createdBy(): SP.User; + get_iD(): number; + get_isCurrentVersion(): bool; + get_size(): number; + get_url(): string; + get_versionLabel(): string; + deleteObject(): void; + } + export class FileVersionCollection extends SP.ClientObjectCollection { + itemAt(index: number): SP.FileVersion; + get_item(index: number): SP.FileVersion; + getById(versionid: number): SP.FileVersion; + deleteByID(vid: number): void; + deleteByLabel(versionlabel: string): void; + deleteAll(): void; + restoreByLabel(versionlabel: string): void; + } + export class Folder extends SP.ClientObject { + get_contentTypeOrder(): SP.ContentTypeId[]; + get_files(): SP.FileCollection; + get_listItemAllFields(): SP.ListItem; + get_itemCount(): number; + get_name(): string; + get_parentFolder(): SP.Folder; + get_properties(): SP.PropertyValues; + get_serverRelativeUrl(): string; + get_folders(): SP.FolderCollection; + get_uniqueContentTypeOrder(): SP.ContentTypeId[]; + set_uniqueContentTypeOrder(value: SP.ContentTypeId[]): void; + get_welcomePage(): string; + set_welcomePage(value: string): void; + update(): void; + deleteObject(): void; + recycle(): SP.GuidResult; + } + export class FolderCollection extends SP.ClientObjectCollection { + itemAt(index: number): SP.Folder; + get_item(index: number): SP.Folder; + getByUrl(url: string): SP.Folder; + add(url: string): SP.Folder; + } + export class Form extends SP.ClientObject { + get_id(): SP.Guid; + get_serverRelativeUrl(): string; + get_formType(): SP.PageType; + } + export class FormCollection extends SP.ClientObjectCollection
{ + itemAt(index: number): SP.Form; + get_item(index: number): SP.Form; + getByPageType(formType: SP.PageType): SP.Form; + getById(id: SP.Guid): SP.Form; + } + export class Principal extends SP.ClientObject { + get_id(): number; + get_isHiddenInUI(): bool; + get_loginName(): string; + get_title(): string; + set_title(value: string): void; + get_principalType(): SP.Utilities.PrincipalType; + } + export class Group extends SP.Principal { + get_allowMembersEditMembership(): bool; + set_allowMembersEditMembership(value: bool): void; + get_allowRequestToJoinLeave(): bool; + set_allowRequestToJoinLeave(value: bool): void; + get_autoAcceptRequestToJoinLeave(): bool; + set_autoAcceptRequestToJoinLeave(value: bool): void; + get_canCurrentUserEditMembership(): bool; + get_canCurrentUserManageGroup(): bool; + get_canCurrentUserViewMembership(): bool; + get_description(): string; + set_description(value: string): void; + get_onlyAllowMembersViewMembership(): bool; + set_onlyAllowMembersViewMembership(value: bool): void; + get_owner(): SP.Principal; + set_owner(value: SP.Principal): void; + get_ownerTitle(): string; + get_requestToJoinLeaveEmailSetting(): string; + set_requestToJoinLeaveEmailSetting(value: string): void; + get_users(): SP.UserCollection; + update(): void; + } + export class GroupCollection extends SP.ClientObjectCollection { + itemAt(index: number): SP.Group; + get_item(index: number): SP.Group; + getByName(name: string): SP.Group; + getById(id: number): SP.Group; + add(parameters: SP.GroupCreationInformation): SP.Group; + removeByLoginName(loginName: string): void; + removeById(id: number): void; + remove(group: SP.Group): void; + } + export class GroupCreationInformation extends SP.ClientValueObject { + get_description(): string; + set_description(value: string): void; + get_title(): string; + set_title(value: string): void; + get_typeId(): string; + writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; + constructor(); + } + export class InformationRightsManagementSettings extends SP.ClientObject { + get_allowPrint(): bool; + set_allowPrint(value: bool): void; + get_allowScript(): bool; + set_allowScript(value: bool): void; + get_allowWriteCopy(): bool; + set_allowWriteCopy(value: bool): void; + get_disableDocumentBrowserView(): bool; + set_disableDocumentBrowserView(value: bool): void; + get_documentAccessExpireDays(): number; + set_documentAccessExpireDays(value: number): void; + get_documentLibraryProtectionExpireDate(): Date; + set_documentLibraryProtectionExpireDate(value: Date): void; + get_enableDocumentAccessExpire(): bool; + set_enableDocumentAccessExpire(value: bool): void; + get_enableDocumentBrowserPublishingView(): bool; + set_enableDocumentBrowserPublishingView(value: bool): void; + get_enableGroupProtection(): bool; + set_enableGroupProtection(value: bool): void; + get_enableLicenseCacheExpire(): bool; + set_enableLicenseCacheExpire(value: bool): void; + get_groupName(): string; + set_groupName(value: string): void; + get_licenseCacheExpireDays(): number; + set_licenseCacheExpireDays(value: number): void; + get_policyDescription(): string; + set_policyDescription(value: string): void; + get_policyTitle(): string; + set_policyTitle(value: string): void; + reset(): void; + update(): void; + } + export class Language extends SP.ClientValueObject { + get_displayName(): string; + get_languageTag(): string; + get_lcid(): number; + get_typeId(): string; + writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; + constructor(); + } + export class SecurableObject extends SP.ClientObject { + get_firstUniqueAncestorSecurableObject(): SP.SecurableObject; + get_hasUniqueRoleAssignments(): bool; + get_roleAssignments(): SP.RoleAssignmentCollection; + resetRoleInheritance(): void; + breakRoleInheritance(copyRoleAssignments: bool, clearSubscopes: bool): void; + } + /** Represents display mode for a control or form */ + export enum ControlMode { + invalid, + displayMode, + editMode, + newMode + } + /** Represents a list on a SharePoint Web site. */ + export class List extends SP.SecurableObject { + /** Gets item by id. */ + getItemById(id: number): SP.ListItem; + /** Gets a value that specifies whether the list supports content types. */ + get_allowContentTypes(): bool; + /** Gets the list definition type on which the list is based. For lists based on OOTB list definitions, return value corresponds the SP.ListTemplateType enumeration. */ + get_baseTemplate(): number; + /** Gets base type for the list. */ + get_baseType(): SP.BaseType; + /** Gets a value that specifies the override of the web application�s BrowserFileHandling property at the list level. */ + get_browserFileHandling(): SP.BrowserFileHandling; + /** Gets the content types that are associated with the list. */ + get_contentTypes(): SP.ContentTypeCollection; + /** Gets a value that specifies whether content types are enabled for the list. */ + get_contentTypesEnabled(): bool; + /** Sets a value that specifies whether content types are enabled for the list. */ + set_contentTypesEnabled(value: bool): void; + /** Gets a value that specifies when the list was created. */ + get_created(): Date; + /** Gets the data source associated with the list, or null if the list is not a virtual list. */ + get_dataSource(): SP.ListDataSource; + /** Gets a value that specifies the default workflow identifier for content approval on the list. */ + get_defaultContentApprovalWorkflowId(): SP.Guid; + /** Sets a value that specifies the default workflow identifier for content approval on the list. */ + set_defaultContentApprovalWorkflowId(value: SP.Guid): void; + /** Gets a value that specifies the location of the default display form for the list. */ + get_defaultDisplayFormUrl(): string; + /** Sets a value that specifies the location of the default display form for the list. */ + set_defaultDisplayFormUrl(value: string): void; + /** Gets a value that specifies the URL of the edit form to use for list items in the list. */ + get_defaultEditFormUrl(): string; + /** Sets a value that specifies the URL of the edit form to use for list items in the list. */ + set_defaultEditFormUrl(value: string): void; + /** Gets a value that specifies the location of the default new form for the list. */ + get_defaultNewFormUrl(): string; + /** Sets a value that specifies the location of the default new form for the list. */ + set_defaultNewFormUrl(value: string): void; + /** Gets default view for the list. */ + get_defaultView(): SP.View; + /** Get URL of the default view for the list. */ + get_defaultViewUrl(): string; + /** Gets a value that specifies the description of the list. */ + get_description(): string; + /** Sets a value that specifies the description of the list. */ + set_description(value: string): void; + /** Gets a value that specifies the reading order of the list. */ + get_direction(): string; + /** Sets a value that specifies the reading order of the list. */ + set_direction(value: string): void; + /** Gets a value that specifies the server-relative URL of the document template for the list */ + get_documentTemplateUrl(): string; + /** Sets a value that specifies the server-relative URL of the document template for the list */ + set_documentTemplateUrl(value: string): void; + /** Gets a value that specifies the minimum permission required to view minor versions and drafts within the list. */ + get_draftVersionVisibility(): SP.DraftVisibilityType; + /** Sets a value that specifies the minimum permission required to view minor versions and drafts within the list. */ + set_draftVersionVisibility(value: SP.DraftVisibilityType): void; + /** Gets a value that specifies the effective permissions on the list that are assigned to the current user. */ + get_effectiveBasePermissions(): SP.BasePermissions; + /** Gets the effective base permissions for the current user, as they should be displayed in UI. This will only differ from EffectiveBasePermissions if ReadOnlyUI is set to true, and in all cases will be a subset of EffectiveBasePermissions. To put it another way, EffectiveBasePermissionsForUI will always be as or more restrictive than EffectiveBasePermissions. */ + get_effectiveBasePermissionsForUI(): SP.BasePermissions; + /** Gets a value that specifies whether list item attachments are enabled for the list. */ + get_enableAttachments(): bool; + /** Sets a value that specifies whether list item attachments are enabled for the list. */ + set_enableAttachments(value: bool): void; + /** Gets a value that specifies whether new list folders can be added to the list. */ + get_enableFolderCreation(): bool; + /** Sets a value that specifies whether new list folders can be added to the list. */ + set_enableFolderCreation(value: bool): void; + /** Gets a value that specifies whether minor versions are enabled for the list. */ + get_enableMinorVersions(): bool; + /** Sets a value that specifies whether minor versions are enabled for the list. */ + set_enableMinorVersions(value: bool): void; + /** Gets a value that specifies whether content approval is enabled for the list. */ + get_enableModeration(): bool; + /** Sets a value that specifies whether content approval is enabled for the list */ + set_enableModeration(value: bool): void; + /** Gets a value that specifies whether historical versions of list items and documents can be created in the list */ + get_enableVersioning(): bool; + /** Sets a value that specifies whether historical versions of list items and documents can be created in the list */ + set_enableVersioning(value: bool): void; + /** The entity type name. */ + get_entityTypeName(): string; + /** Gets collection of event receiver objects associated with the list. */ + get_eventReceivers(): SP.EventReceiverDefinitionCollection; + /** Gets a value that specifies the collection of all fields in the list. */ + get_fields(): SP.FieldCollection; + /** Gets a value that indicates whether forced checkout is enabled for the document library. */ + get_forceCheckout(): bool; + /** Sets a value that indicates whether forced checkout is enabled for the document library */ + set_forceCheckout(value: bool): void; + /** Gets collections of forms associated with the list. */ + get_forms(): SP.FormCollection; + /** Returns true if this is external list. */ + get_hasExternalDataSource(): bool; + /** Gets wherever the list is hidden */ + get_hidden(): bool; + /** Sets if the list is hidden from "All site contents" or not. */ + set_hidden(value: bool): void; + /** Gets id of the list */ + get_id(): SP.Guid; + /** Gets a value that specifies the URI for the icon of the list */ + get_imageUrl(): string; + /** Sets a value that specifies the URI for the icon of the list */ + set_imageUrl(value: string): void; + /** Settings of document library Information Rights Management (IRM) */ + get_informationRightsManagementSettings(): SP.InformationRightsManagementSettings; + /** Gets a value that specifies whether Information Rights Management (IRM) is enabled for the list. */ + get_irmEnabled(): bool; + /** Sets a value that specifies whether Information Rights Management (IRM) is enabled for the list. */ + set_irmEnabled(value: bool): void; + /** Gets a value that specifies whether Information Rights Management (IRM) expiration is enabled for the list. */ + get_irmExpire(): bool; + /** Sets a value that specifies whether Information Rights Management (IRM) expiration is enabled for the list. */ + set_irmExpire(value: bool): void; + /** Gets a value that specifies whether Information Rights Management (IRM) rejection is enabled for the list. */ + get_irmReject(): bool; + /** Sets a value that specifies whether Information Rights Management (IRM) rejection is enabled for the list. */ + set_irmReject(value: bool): void; + /** Indicates whether this list should be treated as a top level navigation object or not. */ + get_isApplicationList(): bool; + /** Sets a value that indicates whether this list should be treated as a top level navigation object or not. */ + set_isApplicationList(value: bool): void; + /** Gets a value that specifies whether the list is a gallery. */ + get_isCatalog(): bool; + /** Gets a value that indicates whether the document library is a private list with restricted permissions, such as for Solutions. */ + get_isPrivate(): bool; + /** Gets a value that indicates whether the list is designated as a default asset location for images or other files which the users upload to their wiki pages. */ + get_isSiteAssetsLibrary(): bool; + /** Gets a value that specifies the number of list items in the list */ + get_itemCount(): number; + /** Gets a value that specifies the last time a list item was deleted from the list. */ + get_lastItemDeletedDate(): Date; + /** Gets a value that specifies the last time a list item, field, or property of the list was modified. */ + get_lastItemModifiedDate(): Date; + /** Sets a value that specifies the last time the list was modified. */ + set_lastItemModifiedDate(value: Date): void; + /** The entity type full name of the list item in the list. */ + get_listItemEntityTypeFullName(): string; + /** Gets a value that indicates whether the list in a Meeting Workspace site contains data for multiple meeting instances within the site */ + get_multipleDataList(): bool; + /** Sets a value that indicates whether the list in a Meeting Workspace site contains data for multiple meeting instances within the site */ + set_multipleDataList(value: bool): void; + /** Gets a value that specifies that the crawler must not crawl the list */ + get_noCrawl(): bool; + /** Sets a value that specifies that the crawler must not crawl the list */ + set_noCrawl(value: bool): void; + /** Gets a value that specifies whether the list appears on the Quick Launch of the site */ + get_onQuickLaunch(): bool; + /** Sets a value that specifies whether the list appears on the Quick Launch of the site */ + set_onQuickLaunch(value: bool): void; + /** Gets a value that specifies the site that contains the list. */ + get_parentWeb(): SP.Web; + /** Gets a value that specifies the server-relative URL of the site that contains the list. */ + get_parentWebUrl(): string; + /** Gets the root folder that contains the files in the list and any related files. */ + get_rootFolder(): SP.Folder; + /** Gets a value that specifies the list schema of the list. */ + get_schemaXml(): string; + /** Gets a value that indicates whether folders can be created within the list. */ + get_serverTemplateCanCreateFolders(): bool; + /** Gets a value that specifies the feature identifier of the feature that contains the list schema for the list. */ + get_templateFeatureId(): SP.Guid; + /** Gets the list title. You can determine list URL from it's root folder URL. */ + get_title(): string; + /** Sets the list title. To change list URL you should change name of the root folder. */ + set_title(value: string): void; + /** Gets collection of custom actions associated with the list. */ + get_userCustomActions(): SP.UserCustomActionCollection; + /** Gets a value that specifies the data validation criteria for a list item. */ + get_validationFormula(): string; + /** Sets a value that specifies the data validation criteria for a list item. */ + set_validationFormula(value: string): void; + /** Gets a value that specifies the error message returned when data validation fails for a list item. */ + get_validationMessage(): string; + /** Sets a value that specifies the error message returned when data validation fails for a list item. */ + set_validationMessage(value: string): void; + /** Returns collection of views added to the list */ + get_views(): SP.ViewCollection; + /** Gets the collection of workflow association objects that represents all the workflows that are associated with the list. */ + get_workflowAssociations(): SP.Workflow.WorkflowAssociationCollection; + /** Returns the collection of changes from the change log that have occurred within the list, based on the specified query. */ + getChanges(query: SP.ChangeQuery): SP.ChangeCollection; + /** Returns array of items describing changes since time specified in the query */ + getListItemChangesSinceToken(query: SP.ChangeLogItemQuery): any[]; + /** Gets the effective permissions that a specified user has on the list. */ + getUserEffectivePermissions(userName: string): SP.BasePermissions; + /** First tries to find if the view already exists. Overwrite it if yes, add a new view if no. Then extract all the adhoc filter/sort info from the URL and build and update the view's xml Returns the url of the new/overwritten view. + @param oldName The name of the view the user did the adhoc filter on (is currently on). + @param newName The desired name the user typed + @param privateView Boolean true when the user wants make a new view that's personal + @param uri Url that keeps all the adhoc filter/sort inforatmion */ + saveAsNewView(oldName: string, newName: string, privateView: bool, uri: string): SP.StringResult; + /** Returns a collection of lookup fields that use this list as a data source and that have FieldLookup.IsRelationship set to true. */ + getRelatedFields(): SP.RelatedFieldCollection; + /** This member is reserved for internal use and is not intended to be used directly from your code. */ + getRelatedFieldsExtendedData(): SP.RelatedFieldExtendedDataCollection; + /** Returns json string which contains all information necessary for rendering the specified list form for the specified itemId. Mode is SP.ControlMode */ + renderListFormData(itemId: number, formId: string, mode: SP.ControlMode): SP.StringResult; + /** Returns the data for the specified query view. */ + renderListData(viewXml: string): SP.StringResult; + /** This member is reserved for internal use and is not intended to be used directly from your code. */ + reserveListItemId(): SP.IntResult; + /** Updates the database with changes that are made to the list object. */ + update(): void; + /** Returns the list view with the specified view identifier. */ + getView(viewGuid: SP.Guid): SP.View; + /** Deletes the list. */ + deleteObject(): void; + /** Sends the list to the site recycle bin. */ + recycle(): SP.GuidResult; + /** Returns collection of list items based on the specified CAML query. */ + getItems(query: SP.CamlQuery): SP.ListItemCollection; + /** Creates a new list item in the list. */ + addItem(parameters: SP.ListItemCreationInformation): SP.ListItem; + } + /** Represents a collection of SP.List objects */ + export class ListCollection extends SP.ClientObjectCollection { + /** Gets the list at the specified index in the collection. */ + itemAt(index: number): SP.List; + /** Gets the list at the specified index in the collection. */ + get_item(index: number): SP.List; + /** Returns the list with the specified title from the collection. */ + getByTitle(title: string): SP.List; + /** Returns the list with the specified list identifier. */ + getById(id: SP.Guid): SP.List; + /** Returns the list with the specified list identifier. */ + getById(id: string): SP.List; + /** Creates a new list or a document library. */ + add(parameters: SP.ListCreationInformation): SP.List; + /** Gets a list that is the default location for wiki pages. */ + ensureSitePagesLibrary(): SP.List; + /** Gets a list that is the default asset location for images or other files, which the users upload to their wiki pages. */ + ensureSiteAssetsLibrary(): SP.List; + } + export class ListCreationInformation extends SP.ClientValueObject { + get_customSchemaXml(): string; + set_customSchemaXml(value: string): void; + get_dataSourceProperties(): any; + set_dataSourceProperties(value: any): void; + get_description(): string; + set_description(value: string): void; + get_documentTemplateType(): number; + set_documentTemplateType(value: number): void; + get_quickLaunchOption(): SP.QuickLaunchOptions; + set_quickLaunchOption(value: SP.QuickLaunchOptions): void; + get_templateFeatureId(): SP.Guid; + set_templateFeatureId(value: SP.Guid): void; + get_templateType(): number; + set_templateType(value: number): void; + get_title(): string; + set_title(value: string): void; + get_url(): string; + set_url(value: string): void; + get_typeId(): string; + writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; + constructor(); + } + export class ListDataSource extends SP.ClientValueObject { + get_properties(): any; + get_typeId(): string; + writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; + constructor(); + } + export class ListDataValidationExceptionValue extends SP.ClientValueObject { + get_fieldFailures(): SP.ListDataValidationFailure[]; + get_itemFailure(): SP.ListDataValidationFailure; + get_typeId(): string; + writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; + constructor(); + } + export class ListDataValidationFailure extends SP.ClientValueObject { + get_displayName(): string; + get_message(): string; + get_name(): string; + get_reason(): SP.ListDataValidationFailureReason; + get_validationType(): SP.ListDataValidationType; + get_typeId(): string; + writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; + constructor(); + } + export enum ListDataValidationFailureReason { + dataFailure, + formulaError, + } + export enum ListDataValidationType { + userFormulaField, + userFormulaItem, + requiredField, + choiceField, + minMaxField, + textField, + } + /** Represents an item or row in a list. */ + export class ListItem extends SP.SecurableObject { + get_fieldValues(): any; + /** Gets the specified field value for the list item. Field value is returned as string, but it can be casted to a specific field value type, e.g. SP.LookupFieldValue, etc. */ + get_item(fieldInternalName: string): any; + /** Sets the specified field value for the list item. Consider using parseAndSetFieldValue instead. */ + set_item(fieldInternalName: string, value: any): void; + /** Gets collection of objects that represent attachments for the list item. */ + get_attachmentFiles(): SP.AttachmentCollection; + /** Gets the content type of the item. */ + get_contentType(): SP.ContentType; + /** Gets a value that specifies the display name of the list item. + This property is not available by default when you return list items. Trying to call this method returns a PropertyOrFieldNotInitializedException if you try to access one of these properties. To access this property, use the Include method as part of the query string. */ + get_displayName(): string; + /** Gets a value that specifies the effective permissions on the list item that are assigned to the current user. + This property is not available by default when you return list items. Trying to call this method returns a PropertyOrFieldNotInitializedException if you try to access one of these properties. To access this property, use the Include method as part of the query string. */ + get_effectiveBasePermissions(): SP.BasePermissions; + /** Gets the effective base permissions for the current user, as they should be displayed in UI. + This will only differ from EffectiveBasePermissions if ReadOnlyUI is set to true on the item's parent list, and in all cases will be a subset of EffectiveBasePermissions. To put it another way, EffectiveBasePermissionsForUI will always be as or more restrictive than EffectiveBasePermissions. + This property is not available by default when you return list items. Trying to call this method returns a PropertyOrFieldNotInitializedException if you try to access one of these properties. To access this property, use the Include method as part of the query string. */ + get_effectiveBasePermissionsForUI(): SP.BasePermissions; + get_fieldValuesAsHtml(): SP.FieldStringValues; + get_fieldValuesAsText(): SP.FieldStringValues; + get_fieldValuesForEdit(): SP.FieldStringValues; + /** Gets the file that is represented by the item from a document library. Only for document libraries. */ + get_file(): SP.File; + /** Gets or sets the file system object type for the item (file, folder or invalid). */ + get_fileSystemObjectType(): SP.FileSystemObjectType; + /** Gets the parent folder for the list item */ + get_folder(): SP.Folder; + /** Gets id of the item */ + get_id(): number; + /** Get the list in which the item resides. */ + get_parentList(): SP.List; + refreshLoad(): void; + getWOPIFrameUrl(action: SP.Utilities.SPWOPIFrameAction): SP.StringResult; + /** Commits changed properties of the list item. The actual update is performed during context.executeQueryAsync method call. */ + update(): void; + /** Deletes the list item */ + deleteObject(): void; + /** Moves the list item to the Recycle Bin and returns the identifier of the new Recycle Bin item. */ + recycle(): SP.GuidResult; + /** Gets effective permissions for the specified user. */ + getUserEffectivePermissions(userName: string): SP.BasePermissions; + /** Sets the value of the field for the list item based on an implementation specific transformation of the value. */ + parseAndSetFieldValue(fieldInternalName: string, value: string): void; + /** Validates form values specified for the list item. Errors are returned through hasException and errorMessage properties of the ListItemFormUpdateValue objects */ + validateUpdateListItem(formValues: SP.ListItemFormUpdateValue[], bNewDocumentUpdate: bool): SP.ListItemFormUpdateValue[]; + } + export class ListItemCollection extends SP.ClientObjectCollection { + itemAt(index: number): SP.ListItem; + get_item(index: number): SP.ListItem; + getById(id: number): SP.ListItem; + getById(id: string): SP.ListItem; + get_listItemCollectionPosition(): SP.ListItemCollectionPosition; + } + export class ListItemCollectionPosition extends SP.ClientValueObject { + get_pagingInfo(): string; + set_pagingInfo(value: string): void; + get_typeId(): string; + writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; + constructor(); + } + /** Specifies the properties of the new list item. */ + export class ListItemCreationInformation extends SP.ClientValueObject { + get_folderUrl(): string; + /** Sets a value that specifies the folder for the new list item. */ + set_folderUrl(value: string): void; + get_leafName(): string; + /** Sets a value that specifies the name of the new list item. It must be the name of the file if the parent list of the list item is a document library. */ + set_leafName(value: string): void; + get_underlyingObjectType(): SP.FileSystemObjectType; + /** Sets a value that specifies whether the new list item is a file or a folder. */ + set_underlyingObjectType(value: SP.FileSystemObjectType): void; + get_typeId(): string; + writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; + constructor(); + } + export class ListItemEntityCollection extends SP.ClientObjectCollection { + itemAt(index: number): SP.ListItem; + get_item(index: number): SP.ListItem; + } + export class ListItemFormUpdateValue extends SP.ClientValueObject { + get_errorMessage(): string; + set_errorMessage(value: string): void; + get_fieldName(): string; + set_fieldName(value: string): void; + get_fieldValue(): string; + set_fieldValue(value: string): void; + get_hasException(): bool; + set_hasException(value: bool): void; + get_typeId(): string; + writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; + constructor(); + } + export class ListTemplate extends SP.ClientObject { + get_allowsFolderCreation(): bool; + get_baseType(): SP.BaseType; + get_description(): string; + get_featureId(): SP.Guid; + get_hidden(): bool; + get_imageUrl(): string; + get_internalName(): string; + get_isCustomTemplate(): bool; + get_name(): string; + get_onQuickLaunch(): bool; + get_listTemplateTypeKind(): number; + get_unique(): bool; + } + export class ListTemplateCollection extends SP.ClientObjectCollection { + itemAt(index: number): SP.ListTemplate; + get_item(index: number): SP.ListTemplate; + getByName(name: string): SP.ListTemplate; + } + export enum ListTemplateType { + invalidType, + noListTemplate, + genericList, + documentLibrary, + survey, + links, + announcements, + contacts, + events, + tasks, + discussionBoard, + pictureLibrary, + dataSources, + webTemplateCatalog, + userInformation, + webPartCatalog, + listTemplateCatalog, + xMLForm, + masterPageCatalog, + noCodeWorkflows, + workflowProcess, + webPageLibrary, + customGrid, + solutionCatalog, + noCodePublic, + themeCatalog, + designCatalog, + appDataCatalog, + dataConnectionLibrary, + workflowHistory, + ganttTasks, + helpLibrary, + accessRequest, + tasksWithTimelineAndHierarchy, + maintenanceLogs, + meetings, + agenda, + meetingUser, + decision, + meetingObjective, + textBox, + thingsToBring, + homePageLibrary, + posts, + comments, + categories, + facility, + whereabouts, + callTrack, + circulation, + timecard, + holidays, + iMEDic, + externalList, + mySiteDocumentLibrary, + issueTracking, + adminTasks, + healthRules, + healthReports, + developerSiteDraftApps, + } + export enum MoveOperations { + none, + overwrite, + allowBrokenThickets, + bypassApprovePermission, + } + export class Navigation extends SP.ClientObject { + get_quickLaunch(): SP.NavigationNodeCollection; + get_topNavigationBar(): SP.NavigationNodeCollection; + get_useShared(): bool; + set_useShared(value: bool): void; + getNodeById(id: number): SP.NavigationNode; + } + export class NavigationNode extends SP.ClientObject { + get_children(): SP.NavigationNodeCollection; + get_id(): number; + get_isDocLib(): bool; + get_isExternal(): bool; + get_isVisible(): bool; + set_isVisible(value: bool): void; + get_title(): string; + set_title(value: string): void; + get_url(): string; + set_url(value: string): void; + update(): void; + deleteObject(): void; + } + export class NavigationNodeCollection extends SP.ClientObjectCollection { + itemAt(index: number): SP.NavigationNode; + get_item(index: number): SP.NavigationNode; + add(parameters: SP.NavigationNodeCreationInformation): SP.NavigationNode; + } + export class NavigationNodeCreationInformation extends SP.ClientValueObject { + get_asLastNode(): bool; + set_asLastNode(value: bool): void; + get_isExternal(): bool; + set_isExternal(value: bool): void; + get_previousNode(): SP.NavigationNode; + set_previousNode(value: SP.NavigationNode): void; + get_title(): string; + set_title(value: string): void; + get_url(): string; + set_url(value: string): void; + get_typeId(): string; + writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; + constructor(); + } + export class ObjectSharingInformation extends SP.ClientObject { + get_anonymousEditLink(): string; + get_anonymousViewLink(): string; + get_canManagePermissions(): bool; + get_hasPendingAccessRequests(): bool; + get_hasPermissionLevels(): bool; + get_isSharedWithCurrentUser(): bool; + get_isSharedWithGuest(): bool; + get_isSharedWithMany(): bool; + get_isSharedWithSecurityGroup(): bool; + get_pendingAccessRequestsLink(): string; + getSharedWithUsers(): SP.ClientObjectList; + static getListItemSharingInformation(context: SP.ClientRuntimeContext, listID: SP.Guid, itemID: number, excludeCurrentUser: bool, excludeSiteAdmin: bool, excludeSecurityGroups: bool, retrieveAnonymousLinks: bool, retrieveUserInfoDetails: bool, checkForAccessRequests: bool): SP.ObjectSharingInformation; + static getWebSharingInformation(context: SP.ClientRuntimeContext, excludeCurrentUser: bool, excludeSiteAdmin: bool, excludeSecurityGroups: bool, retrieveAnonymousLinks: bool, retrieveUserInfoDetails: bool, checkForAccessRequests: bool): SP.ObjectSharingInformation; + static getObjectSharingInformation(context: SP.ClientRuntimeContext, securableObject: SP.SecurableObject, excludeCurrentUser: bool, excludeSiteAdmin: bool, excludeSecurityGroups: bool, retrieveAnonymousLinks: bool, retrieveUserInfoDetails: bool, checkForAccessRequests: bool, retrievePermissionLevels: bool): SP.ObjectSharingInformation; + } + export class ObjectSharingInformationUser extends SP.ClientObject { + get_customRoleNames(): string; + get_department(): string; + get_email(): string; + get_hasEditPermission(): bool; + get_hasViewPermission(): bool; + get_id(): number; + get_isSiteAdmin(): bool; + get_jobTitle(): string; + get_loginName(): string; + get_name(): string; + get_picture(): string; + get_principal(): SP.Principal; + get_sipAddress(): string; + get_user(): SP.User; + } + export enum OpenWebOptions { + none, + initNavigationCache, + } + export enum PageType { + invalid, + defaultView, + normalView, + dialogView, + view, + displayForm, + displayFormDialog, + editForm, + editFormDialog, + newForm, + newFormDialog, + solutionForm, + pAGE_MAXITEMS, + } + export class PropertyValues extends SP.ClientObject { + get_fieldValues(): any; + get_item(fieldName: string): any; + set_item(fieldName: string, value: any): void; + refreshLoad(): void; + } + export class PushNotificationSubscriber extends SP.ClientObject { + get_customArgs(): string; + set_customArgs(value: string): void; + get_deviceAppInstanceId(): SP.Guid; + get_lastModifiedTimeStamp(): Date; + get_registrationTimeStamp(): Date; + get_serviceToken(): string; + set_serviceToken(value: string): void; + get_subscriberType(): string; + set_subscriberType(value: string): void; + get_user(): SP.User; + update(): void; + } + export class PushNotificationSubscriberCollection extends SP.ClientObjectCollection { + itemAt(index: number): SP.PushNotificationSubscriber; + get_item(index: number): SP.PushNotificationSubscriber; + getByStoreId(id: string): SP.PushNotificationSubscriber; + } + export enum QuickLaunchOptions { + off, + on, + defaultValue, + } + export class RecycleBinItem extends SP.ClientObject { + get_author(): SP.User; + get_deletedBy(): SP.User; + get_deletedDate(): Date; + get_dirName(): string; + get_id(): SP.Guid; + get_itemState(): SP.RecycleBinItemState; + get_itemType(): SP.RecycleBinItemType; + get_leafName(): string; + get_size(): number; + get_title(): string; + deleteObject(): void; + restore(): void; + } + export class RecycleBinItemCollection extends SP.ClientObjectCollection { + itemAt(index: number): SP.RecycleBinItem; + get_item(index: number): SP.RecycleBinItem; + getById(id: SP.Guid): SP.RecycleBinItem; + deleteAll(): void; + restoreAll(): void; + } + export enum RecycleBinItemState { + none, + firstStageRecycleBin, + secondStageRecycleBin, + } + export enum RecycleBinItemType { + none, + file, + fileVersion, + listItem, + list, + folder, + folderWithLists, + attachment, + listItemVersion, + cascadeParent, + web, + } + export class RegionalSettings extends SP.ClientObject { + get_adjustHijriDays(): number; + get_alternateCalendarType(): number; + get_aM(): string; + get_calendarType(): number; + get_collation(): number; + get_collationLCID(): number; + get_dateFormat(): number; + get_dateSeparator(): string; + get_decimalSeparator(): string; + get_digitGrouping(): string; + get_firstDayOfWeek(): number; + get_firstWeekOfYear(): number; + get_isEastAsia(): bool; + get_isRightToLeft(): bool; + get_isUIRightToLeft(): bool; + get_listSeparator(): string; + get_localeId(): number; + get_negativeSign(): string; + get_negNumberMode(): number; + get_pM(): string; + get_positiveSign(): string; + get_showWeeks(): bool; + get_thousandSeparator(): string; + get_time24(): bool; + get_timeMarkerPosition(): number; + get_timeSeparator(): string; + get_timeZone(): SP.TimeZone; + get_timeZones(): SP.TimeZoneCollection; + get_workDayEndHour(): number; + get_workDays(): number; + get_workDayStartHour(): number; + } + export class RelatedField extends SP.ClientObject { + get_fieldId(): SP.Guid; + get_listId(): SP.Guid; + get_lookupList(): SP.List; + get_relationshipDeleteBehavior(): SP.RelationshipDeleteBehaviorType; + get_webId(): SP.Guid; + } + export class RelatedFieldCollection extends SP.ClientObjectCollection { + itemAt(index: number): SP.RelatedField; + get_item(index: number): SP.RelatedField; + } + export class RelatedFieldExtendedData extends SP.ClientObject { + get_fieldId(): SP.Guid; + get_listId(): SP.Guid; + get_listImageUrl(): string; + get_resolvedListTitle(): string; + get_toolTipDescription(): string; + get_webId(): SP.Guid; + } + export class RelatedFieldExtendedDataCollection extends SP.ClientObjectCollection { + itemAt(index: number): SP.RelatedFieldExtendedData; + get_item(index: number): SP.RelatedFieldExtendedData; + } + export class RelatedItem extends SP.ClientValueObject { + get_iconUrl(): string; + set_iconUrl(value: string): void; + get_itemId(): number; + set_itemId(value: number): void; + get_listId(): string; + set_listId(value: string): void; + get_title(): string; + set_title(value: string): void; + get_url(): string; + set_url(value: string): void; + get_webId(): string; + set_webId(value: string): void; + get_typeId(): string; + writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; + constructor(); + } + export class RelatedItemManager extends SP.ClientObject { + static getRelatedItems(context: SP.ClientRuntimeContext, SourceListName: string, SourceItemID: number): SP.RelatedItem[]; + static getPageOneRelatedItems(context: SP.ClientRuntimeContext, SourceListName: string, SourceItemID: number): SP.RelatedItem[]; + static addSingleLink(context: SP.ClientRuntimeContext, SourceListName: string, SourceItemID: number, SourceWebUrl: string, TargetListName: string, TargetItemID: number, TargetWebUrl: string, TryAddReverseLink: bool): void; + static addSingleLinkToUrl(context: SP.ClientRuntimeContext, SourceListName: string, SourceItemID: number, TargetItemUrl: string, TryAddReverseLink: bool): void; + static addSingleLinkFromUrl(context: SP.ClientRuntimeContext, SourceItemUrl: string, TargetListName: string, TargetItemID: number, TryAddReverseLink: bool): void; + static deleteSingleLink(context: SP.ClientRuntimeContext, SourceListName: string, SourceItemID: number, SourceWebUrl: string, TargetListName: string, TargetItemID: number, TargetWebUrl: string, TryDeleteReverseLink: bool): void; + } + export enum RelationshipDeleteBehaviorType { + none, + cascade, + restrict, + } + export class RequestVariable extends SP.ClientObject { + constructor(context: SP.ClientRuntimeContext); + get_value(): string; + static newObject(context: SP.ClientRuntimeContext): SP.RequestVariable; + append(value: string): void; + set (value: string): void; + } + export class RoleAssignment extends SP.ClientObject { + get_member(): SP.Principal; + get_principalId(): number; + get_roleDefinitionBindings(): SP.RoleDefinitionBindingCollection; + importRoleDefinitionBindings(roleDefinitionBindings: SP.RoleDefinitionBindingCollection): void; + update(): void; + deleteObject(): void; + } + export class RoleAssignmentCollection extends SP.ClientObjectCollection { + itemAt(index: number): SP.RoleAssignment; + get_item(index: number): SP.RoleAssignment; + get_groups(): SP.GroupCollection; + getByPrincipal(principalToFind: SP.Principal): SP.RoleAssignment; + getByPrincipalId(principalId: number): SP.RoleAssignment; + add(principal: SP.Principal, roleBindings: SP.RoleDefinitionBindingCollection): SP.RoleAssignment; + } + export class RoleDefinition extends SP.ClientObject { + get_basePermissions(): SP.BasePermissions; + set_basePermissions(value: SP.BasePermissions): void; + get_description(): string; + set_description(value: string): void; + get_hidden(): bool; + get_id(): number; + get_name(): string; + set_name(value: string): void; + get_order(): number; + set_order(value: number): void; + get_roleTypeKind(): SP.RoleType; + update(): void; + deleteObject(): void; + } + export class RoleDefinitionBindingCollection extends SP.ClientObjectCollection { + itemAt(index: number): SP.RoleDefinition; + get_item(index: number): SP.RoleDefinition; + constructor(context: SP.ClientRuntimeContext); + static newObject(context: SP.ClientRuntimeContext): SP.RoleDefinitionBindingCollection; + add(roleDefinition: SP.RoleDefinition): void; + remove(roleDefinition: SP.RoleDefinition): void; + removeAll(): void; + } + export class RoleDefinitionCollection extends SP.ClientObjectCollection { + itemAt(index: number): SP.RoleDefinition; + get_item(index: number): SP.RoleDefinition; + getByName(name: string): SP.RoleDefinition; + add(parameters: SP.RoleDefinitionCreationInformation): SP.RoleDefinition; + getById(id: number): SP.RoleDefinition; + getByType(roleType: SP.RoleType): SP.RoleDefinition; + } + export class RoleDefinitionCreationInformation extends SP.ClientValueObject { + get_basePermissions(): SP.BasePermissions; + set_basePermissions(value: SP.BasePermissions): void; + get_description(): string; + set_description(value: string): void; + get_name(): string; + set_name(value: string): void; + get_order(): number; + set_order(value: number): void; + get_typeId(): string; + writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; + constructor(); + } + export enum RoleType { + none, + guest, + reader, + contributor, + webDesigner, + administrator, + editor, + } + export class ServerSettings { + static getAlternateUrls(context: SP.ClientRuntimeContext): SP.ClientObjectList; + static getGlobalInstalledLanguages(context: SP.ClientRuntimeContext, compatibilityLevel: number): SP.Language[]; + } + export class Site extends SP.ClientObject { + get_allowDesigner(): bool; + set_allowDesigner(value: bool): void; + get_allowMasterPageEditing(): bool; + set_allowMasterPageEditing(value: bool): void; + get_allowRevertFromTemplate(): bool; + set_allowRevertFromTemplate(value: bool): void; + get_allowSelfServiceUpgrade(): bool; + set_allowSelfServiceUpgrade(value: bool): void; + get_allowSelfServiceUpgradeEvaluation(): bool; + set_allowSelfServiceUpgradeEvaluation(value: bool): void; + get_canUpgrade(): bool; + get_compatibilityLevel(): number; + get_eventReceivers(): SP.EventReceiverDefinitionCollection; + get_features(): SP.FeatureCollection; + get_id(): SP.Guid; + get_lockIssue(): string; + get_maxItemsPerThrottledOperation(): number; + get_owner(): SP.User; + set_owner(value: SP.User): void; + get_primaryUri(): string; + get_readOnly(): bool; + get_recycleBin(): SP.RecycleBinItemCollection; + get_rootWeb(): SP.Web; + get_serverRelativeUrl(): string; + get_shareByLinkEnabled(): bool; + get_showUrlStructure(): bool; + set_showUrlStructure(value: bool): void; + get_uIVersionConfigurationEnabled(): bool; + set_uIVersionConfigurationEnabled(value: bool): void; + get_upgradeInfo(): SP.UpgradeInfo; + get_upgradeReminderDate(): Date; + get_upgrading(): bool; + get_url(): string; + get_usage(): SP.UsageInfo; + get_userCustomActions(): SP.UserCustomActionCollection; + updateClientObjectModelUseRemoteAPIsPermissionSetting(requireUseRemoteAPIs: bool): void; + needsUpgradeByType(versionUpgrade: bool, recursive: bool): SP.BooleanResult; + runHealthCheck(ruleId: SP.Guid, bRepair: bool, bRunAlways: bool): SP.SiteHealth.SiteHealthSummary; + createPreviewSPSite(upgrade: bool, sendemail: bool): void; + runUpgradeSiteSession(versionUpgrade: bool, queueOnly: bool, sendEmail: bool): void; + getChanges(query: SP.ChangeQuery): SP.ChangeCollection; + openWeb(strUrl: string): SP.Web; + openWebById(gWebId: SP.Guid): SP.Web; + getWebTemplates(LCID: number, overrideCompatLevel: number): SP.WebTemplateCollection; + getCustomListTemplates(web: SP.Web): SP.ListTemplateCollection; + getCatalog(typeCatalog: number): SP.List; + extendUpgradeReminderDate(): void; + invalidate(): void; + } + export class SiteUrl extends SP.ClientObject { + } + export class SubwebQuery extends SP.ClientValueObject { + get_configurationFilter(): number; + set_configurationFilter(value: number): void; + get_webTemplateFilter(): number; + set_webTemplateFilter(value: number): void; + get_typeId(): string; + writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; + constructor(); + } + export enum TemplateFileType { + standardPage, + wikiPage, + formPage, + } + export class ThemeInfo extends SP.ClientObject { + get_accessibleDescription(): string; + get_themeBackgroundImageUri(): string; + getThemeShadeByName(name: string): SP.StringResult; + getThemeFontByName(name: string, lcid: number): SP.StringResult; + } + export class TimeZone extends SP.ClientObject { + get_description(): string; + get_id(): number; + get_information(): SP.TimeZoneInformation; + localTimeToUTC(date: Date): SP.DateTimeResult; + uTCToLocalTime(date: Date): SP.DateTimeResult; + } + export class TimeZoneCollection extends SP.ClientObjectCollection { + itemAt(index: number): SP.TimeZone; + get_item(index: number): SP.TimeZone; + getById(id: number): SP.TimeZone; + } + export class TimeZoneInformation extends SP.ClientValueObject { + get_bias(): number; + get_daylightBias(): number; + get_standardBias(): number; + get_typeId(): string; + writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; + constructor(); + } + export class UpgradeInfo extends SP.ClientValueObject { + get_errorFile(): string; + get_errors(): number; + get_lastUpdated(): Date; + get_logFile(): string; + get_requestDate(): Date; + get_retryCount(): number; + get_startTime(): Date; + get_status(): SP.UpgradeStatus; + get_upgradeType(): SP.UpgradeType; + get_warnings(): number; + get_typeId(): string; + writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; + constructor(); + } + export enum UpgradeStatus { + none, + inProgress, + failed, + completed, + } + export enum UpgradeType { + buildUpgrade, + versionUpgrade, + } + export enum UrlFieldFormatType { + hyperlink, + image, + } + export enum UrlZone { + defaultZone, + intranet, + internet, + custom, + extranet, + } + export class UsageInfo extends SP.ClientValueObject { + get_bandwidth(): number; + get_discussionStorage(): number; + get_hits(): number; + get_storage(): number; + get_storagePercentageUsed(): number; + get_visits(): number; + get_typeId(): string; + writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; + constructor(); + } + export class User extends SP.Principal { + get_email(): string; + set_email(value: string): void; + get_groups(): SP.GroupCollection; + get_isSiteAdmin(): bool; + set_isSiteAdmin(value: bool): void; + get_userId(): SP.UserIdInfo; + update(): void; + } + export class UserCollection extends SP.ClientObjectCollection { + itemAt(index: number): SP.User; + get_item(index: number): SP.User; + getByLoginName(loginName: string): SP.User; + getById(id: number): SP.User; + getByEmail(emailAddress: string): SP.User; + removeByLoginName(loginName: string): void; + removeById(id: number): void; + remove(user: SP.User): void; + add(parameters: SP.UserCreationInformation): SP.User; + addUser(user: SP.User): SP.User; + } + export class UserCreationInformation extends SP.ClientValueObject { + get_email(): string; + set_email(value: string): void; + get_loginName(): string; + set_loginName(value: string): void; + get_title(): string; + set_title(value: string): void; + get_typeId(): string; + writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; + constructor(); + } + export class UserCustomAction extends SP.ClientObject { + get_commandUIExtension(): string; + set_commandUIExtension(value: string): void; + get_description(): string; + set_description(value: string): void; + get_group(): string; + set_group(value: string): void; + get_id(): SP.Guid; + get_imageUrl(): string; + set_imageUrl(value: string): void; + get_location(): string; + set_location(value: string): void; + get_name(): string; + set_name(value: string): void; + get_registrationId(): string; + set_registrationId(value: string): void; + get_registrationType(): SP.UserCustomActionRegistrationType; + set_registrationType(value: SP.UserCustomActionRegistrationType): void; + get_rights(): SP.BasePermissions; + set_rights(value: SP.BasePermissions): void; + get_scope(): SP.UserCustomActionScope; + get_scriptBlock(): string; + set_scriptBlock(value: string): void; + get_scriptSrc(): string; + set_scriptSrc(value: string): void; + get_sequence(): number; + set_sequence(value: number): void; + get_title(): string; + set_title(value: string): void; + get_url(): string; + set_url(value: string): void; + get_versionOfUserCustomAction(): string; + update(): void; + deleteObject(): void; + } + export class UserCustomActionCollection extends SP.ClientObjectCollection { + itemAt(index: number): SP.UserCustomAction; + get_item(index: number): SP.UserCustomAction; + getById(id: SP.Guid): SP.UserCustomAction; + clear(): void; + add(): SP.UserCustomAction; + } + export enum UserCustomActionRegistrationType { + none, + list, + contentType, + progId, + fileType, + } + export enum UserCustomActionScope { + unknown, + site, + web, + list, + } + export class UserIdInfo extends SP.ClientValueObject { + get_nameId(): string; + get_nameIdIssuer(): string; + get_typeId(): string; + writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; + constructor(); + } + export class View extends SP.ClientObject { + get_aggregations(): string; + set_aggregations(value: string): void; + get_aggregationsStatus(): string; + set_aggregationsStatus(value: string): void; + get_baseViewId(): string; + get_contentTypeId(): SP.ContentTypeId; + set_contentTypeId(value: SP.ContentTypeId): void; + get_defaultView(): bool; + set_defaultView(value: bool): void; + get_defaultViewForContentType(): bool; + set_defaultViewForContentType(value: bool): void; + get_editorModified(): bool; + set_editorModified(value: bool): void; + get_formats(): string; + set_formats(value: string): void; + get_hidden(): bool; + set_hidden(value: bool): void; + get_htmlSchemaXml(): string; + get_id(): SP.Guid; + get_imageUrl(): string; + get_includeRootFolder(): bool; + set_includeRootFolder(value: bool): void; + get_viewJoins(): string; + set_viewJoins(value: string): void; + get_jSLink(): string; + set_jSLink(value: string): void; + get_listViewXml(): string; + set_listViewXml(value: string): void; + get_method(): string; + set_method(value: string): void; + get_mobileDefaultView(): bool; + set_mobileDefaultView(value: bool): void; + get_mobileView(): bool; + set_mobileView(value: bool): void; + get_moderationType(): string; + get_orderedView(): bool; + get_paged(): bool; + set_paged(value: bool): void; + get_personalView(): bool; + get_viewProjectedFields(): string; + set_viewProjectedFields(value: string): void; + get_viewQuery(): string; + set_viewQuery(value: string): void; + get_readOnlyView(): bool; + get_requiresClientIntegration(): bool; + get_rowLimit(): number; + set_rowLimit(value: number): void; + get_scope(): SP.ViewScope; + set_scope(value: SP.ViewScope): void; + get_serverRelativeUrl(): string; + get_styleId(): string; + get_threaded(): bool; + get_title(): string; + set_title(value: string): void; + get_toolbar(): string; + set_toolbar(value: string): void; + get_toolbarTemplateName(): string; + get_viewType(): string; + get_viewData(): string; + set_viewData(value: string): void; + get_viewFields(): SP.ViewFieldCollection; + deleteObject(): void; + renderAsHtml(): SP.StringResult; + update(): void; + } + export class ViewCollection extends SP.ClientObjectCollection { + itemAt(index: number): SP.View; + get_item(index: number): SP.View; + getByTitle(strTitle: string): SP.View; + getById(guidId: SP.Guid): SP.View; + add(parameters: SP.ViewCreationInformation): SP.View; + } + export class ViewCreationInformation extends SP.ClientValueObject { + get_paged(): bool; + set_paged(value: bool): void; + get_personalView(): bool; + set_personalView(value: bool): void; + get_query(): string; + set_query(value: string): void; + get_rowLimit(): number; + set_rowLimit(value: number): void; + get_setAsDefaultView(): bool; + set_setAsDefaultView(value: bool): void; + get_title(): string; + set_title(value: string): void; + get_viewFields(): string[]; + set_viewFields(value: string[]): void; + get_viewTypeKind(): SP.ViewType; + set_viewTypeKind(value: SP.ViewType): void; + get_typeId(): string; + writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; + constructor(); + } + export class ViewFieldCollection extends SP.ClientObjectCollection { + itemAt(index: number): string; + get_item(index: number): string; + get_schemaXml(): string; + moveFieldTo(field: string, index: number): void; + add(strField: string): void; + remove(strField: string): void; + removeAll(): void; + } + export enum ViewScope { + defaultValue, + recursive, + recursiveAll, + filesOnly, + } + export enum ViewType { + none, + html, + grid, + calendar, + recurrence, + chart, + gantt, + } + export class Web extends SP.SecurableObject { + get_allowDesignerForCurrentUser(): bool; + get_allowMasterPageEditingForCurrentUser(): bool; + get_allowRevertFromTemplateForCurrentUser(): bool; + get_allowRssFeeds(): bool; + get_allProperties(): SP.PropertyValues; + get_appInstanceId(): SP.Guid; + get_associatedMemberGroup(): SP.Group; + set_associatedMemberGroup(value: SP.Group): void; + get_associatedOwnerGroup(): SP.Group; + set_associatedOwnerGroup(value: SP.Group): void; + get_associatedVisitorGroup(): SP.Group; + set_associatedVisitorGroup(value: SP.Group): void; + get_availableContentTypes(): SP.ContentTypeCollection; + get_availableFields(): SP.FieldCollection; + get_configuration(): number; + get_contentTypes(): SP.ContentTypeCollection; + get_created(): Date; + get_currentUser(): SP.User; + get_customMasterUrl(): string; + set_customMasterUrl(value: string): void; + get_description(): string; + set_description(value: string): void; + get_documentLibraryCalloutOfficeWebAppPreviewersDisabled(): bool; + get_effectiveBasePermissions(): SP.BasePermissions; + get_enableMinimalDownload(): bool; + set_enableMinimalDownload(value: bool): void; + get_eventReceivers(): SP.EventReceiverDefinitionCollection; + get_features(): SP.FeatureCollection; + get_fields(): SP.FieldCollection; + get_folders(): SP.FolderCollection; + get_id(): SP.Guid; + get_language(): number; + get_lastItemModifiedDate(): Date; + get_lists(): SP.ListCollection; + get_listTemplates(): SP.ListTemplateCollection; + get_masterUrl(): string; + set_masterUrl(value: string): void; + get_navigation(): SP.Navigation; + get_parentWeb(): SP.WebInformation; + get_pushNotificationSubscribers(): SP.PushNotificationSubscriberCollection; + get_quickLaunchEnabled(): bool; + set_quickLaunchEnabled(value: bool): void; + get_recycleBin(): SP.RecycleBinItemCollection; + get_recycleBinEnabled(): bool; + get_regionalSettings(): SP.RegionalSettings; + get_roleDefinitions(): SP.RoleDefinitionCollection; + get_rootFolder(): SP.Folder; + get_saveSiteAsTemplateEnabled(): bool; + set_saveSiteAsTemplateEnabled(value: bool): void; + get_serverRelativeUrl(): string; + set_serverRelativeUrl(value: string): void; + get_showUrlStructureForCurrentUser(): bool; + get_siteGroups(): SP.GroupCollection; + get_siteUserInfoList(): SP.List; + get_siteUsers(): SP.UserCollection; + get_supportedUILanguageIds(): number[]; + get_syndicationEnabled(): bool; + set_syndicationEnabled(value: bool): void; + get_themeInfo(): SP.ThemeInfo; + get_title(): string; + set_title(value: string): void; + get_treeViewEnabled(): bool; + set_treeViewEnabled(value: bool): void; + get_uIVersion(): number; + set_uIVersion(value: number): void; + get_uIVersionConfigurationEnabled(): bool; + set_uIVersionConfigurationEnabled(value: bool): void; + get_url(): string; + get_userCustomActions(): SP.UserCustomActionCollection; + get_webs(): SP.WebCollection; + get_webTemplate(): string; + get_workflowAssociations(): SP.Workflow.WorkflowAssociationCollection; + get_workflowTemplates(): SP.Workflow.WorkflowTemplateCollection; + doesUserHavePermissions(permissionMask: SP.BasePermissions): SP.BooleanResult; + getUserEffectivePermissions(userName: string): SP.BasePermissions; + mapToIcon(fileName: string, progId: string, size: SP.Utilities.IconSize): SP.StringResult; + registerPushNotificationSubscriber(deviceAppInstanceId: SP.Guid, serviceToken: string): SP.PushNotificationSubscriber; + unregisterPushNotificationSubscriber(deviceAppInstanceId: SP.Guid): void; + getPushNotificationSubscribersByArgs(customArgs: string): SP.PushNotificationSubscriberCollection; + getPushNotificationSubscribersByUser(userName: string): SP.PushNotificationSubscriberCollection; + doesPushNotificationSubscriberExist(deviceAppInstanceId: SP.Guid): SP.BooleanResult; + getPushNotificationSubscriber(deviceAppInstanceId: SP.Guid): SP.PushNotificationSubscriber; + getUserById(userId: number): SP.User; + getAvailableWebTemplates(lcid: number, doIncludeCrossLanguage: bool): SP.WebTemplateCollection; + getCatalog(typeCatalog: number): SP.List; + getChanges(query: SP.ChangeQuery): SP.ChangeCollection; + applyWebTemplate(webTemplate: string): void; + deleteObject(): void; + update(): void; + getFileByServerRelativeUrl(serverRelativeUrl: string): SP.File; + getFolderByServerRelativeUrl(serverRelativeUrl: string): SP.Folder; + getEntity(namespace: string, name: string): SP.BusinessData.Entity; + getAppBdcCatalogForAppInstance(appInstanceId: SP.Guid): SP.BusinessData.AppBdcCatalog; + getAppBdcCatalog(): SP.BusinessData.AppBdcCatalog; + getSubwebsForCurrentUser(query: SP.SubwebQuery): SP.WebCollection; + getAppInstanceById(appInstanceId: SP.Guid): SP.AppInstance; + getAppInstancesByProductId(productId: SP.Guid): SP.ClientObjectList; + loadAndInstallAppInSpecifiedLocale(appPackageStream: any[], installationLocaleLCID: number): SP.AppInstance; + loadApp(appPackageStream: any[], installationLocaleLCID: number): SP.AppInstance; + loadAndInstallApp(appPackageStream: any[]): SP.AppInstance; + ensureUser(logonName: string): SP.User; + applyTheme(colorPaletteUrl: string, fontSchemeUrl: string, backgroundImageUrl: string, shareGenerated: bool): void; + } + export class WebCollection extends SP.ClientObjectCollection { + itemAt(index: number): SP.Web; + get_item(index: number): SP.Web; + add(parameters: SP.WebCreationInformation): SP.Web; + } + export class WebCreationInformation extends SP.ClientValueObject { + get_description(): string; + set_description(value: string): void; + get_language(): number; + set_language(value: number): void; + get_title(): string; + set_title(value: string): void; + get_url(): string; + set_url(value: string): void; + get_useSamePermissionsAsParentSite(): bool; + set_useSamePermissionsAsParentSite(value: bool): void; + get_webTemplate(): string; + set_webTemplate(value: string): void; + get_typeId(): string; + writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; + constructor(); + } + export class WebInformation extends SP.ClientObject { + get_configuration(): number; + get_created(): Date; + get_description(): string; + get_id(): SP.Guid; + get_language(): number; + get_lastItemModifiedDate(): Date; + get_serverRelativeUrl(): string; + get_title(): string; + get_webTemplate(): string; + get_webTemplateId(): number; + } + export class WebProxy { + static invoke(context: SP.ClientRuntimeContext, requestInfo: SP.WebRequestInfo): SP.WebResponseInfo; + } + export class WebRequestInfo extends SP.ClientValueObject { + get_body(): string; + set_body(value: string): void; + get_headers(): any; + set_headers(value: any): void; + get_method(): string; + set_method(value: string): void; + get_url(): string; + set_url(value: string): void; + get_typeId(): string; + writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; + constructor(); + } + export class WebResponseInfo extends SP.ClientValueObject { + get_body(): string; + set_body(value: string): void; + get_headers(): any; + set_headers(value: any): void; + get_statusCode(): number; + set_statusCode(value: number): void; + get_typeId(): string; + writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; + constructor(); + } + export class WebTemplate extends SP.ClientObject { + get_description(): string; + get_displayCategory(): string; + get_id(): number; + get_imageUrl(): string; + get_isHidden(): bool; + get_isRootWebOnly(): bool; + get_isSubWebOnly(): bool; + get_lcid(): number; + get_name(): string; + get_title(): string; + } + export class WebTemplateCollection extends SP.ClientObjectCollection { + itemAt(index: number): SP.WebTemplate; + get_item(index: number): SP.WebTemplate; + getByName(name: string): SP.WebTemplate; + } + + export module Application { + export module UI { + export interface DefaultFormsInformationRequestor { + onDefaultFormsInformationRetrieveSuccess(defaultForms: SP.Application.UI.DefaultFormsInformation): void; + onDefaultFormsInformationRetrieveFailure(): void; + } + export class FormsInfo { + ContentTypeName: string; + NewFormUrl: string; + DisplayFormUrl: string; + EditFormUrl: string; + constructor(); + } + export class DefaultFormsInformation { + DefaultForms: SP.Application.UI.FormsInfo; + OtherForms: any; + constructor(); + } + export class DefaultFormsMenuBuilder { + static getDefaultFormsInformation(requestor: SP.Application.UI.DefaultFormsInformationRequestor, listId: SP.Guid): void; + } + export class ViewSelectorMenuOptions { + showRepairView: bool; + showMergeView: bool; + showEditView: bool; + showCreateView: bool; + showApproverView: bool; + listId: string; + viewId: string; + viewParameters: string; + constructor(); + } + export interface ViewInformationRequestor { + onViewInformationReturned(viewGroups: SP.Application.UI.ViewSelectorGroups): void; + } + export class ViewSelectorGroups { + ModeratedViews: any; + PublicViews: any; + PersonalViews: any; + OtherViews: any; + DefaultView: SP.Application.UI.ViewSelectorMenuItem; + ViewCreation: any; + constructor(); + } + export class ViewSelectorMenuItem { + Text: string; + ActionScriptText: string; + NavigateUrl: string; + ImageSourceUrl: string; + Description: string; + Id: string; + Sequence: number; + ItemType: string; + GroupId: number; + constructor(); + } + export class ViewSelectorSubMenu { + Text: string; + ImageSourceUrl: string; + SubMenuItems: any; + constructor(); + } + export class ViewSelectorMenuBuilder { + static get_filterMenuItemsCallback(): (menuItems: any) => any; + static set_filterMenuItemsCallback(value: (menuItems: any) => any): void; + static showMenu(elem: HTMLElement, options: SP.Application.UI.ViewSelectorMenuOptions): void; + static getViewInformation(requestor: SP.Application.UI.ViewInformationRequestor, options: SP.Application.UI.ViewSelectorMenuOptions): void; + } + export class MoreColorsPicker extends Sys.UI.Control { + constructor(e: HTMLElement); + initialize(): void; + dispose(): void; + get_colorValue(): string; + set_colorValue(value: string): void; + } + export class MoreColorsPage extends Sys.UI.Control { + constructor(e: HTMLElement); + initialize(): void; + dispose(): void; + get_moreColorsPicker(): SP.Application.UI.MoreColorsPicker; + set_moreColorsPicker(value: SP.Application.UI.MoreColorsPicker): void; + } + export class ThemeWebPage extends Sys.UI.Control { + add_themeDisplayUpdated(value: (sender: any, e: Sys.EventArgs) => void ): void; + remove_themeDisplayUpdated(value: (sender: any, e: Sys.EventArgs) => void ): void; + constructor(e: HTMLElement); + initialize(): void; + dispose(): void; + onThemeSelectionChanged(evt: Sys.UI.DomEvent): void; + updateThemeDisplay(): void; + get_thmxThemes(): any; + set_thmxThemes(value: any): void; + } + export class WikiPageNameInPlaceEditor { + constructor(ownerDoc: any, displayElemId: string, editElemId: string, editTextBoxId: string); + editingPageCallback(): void; + savingPageCallback(): void; + } + } + } + + + export module Analytics { + export class AnalyticsUsageEntry extends SP.ClientObject { + static logAnalyticsEvent(context: SP.ClientRuntimeContext, eventTypeId: number, itemId: string): void; + static logAnalyticsEvent2(context: SP.ClientRuntimeContext, eventTypeId: number, itemId: string, rollupScopeId: SP.Guid, siteId: SP.Guid, userId: string): void; + static logAnalyticsAppEvent(context: SP.ClientRuntimeContext, appEventTypeId: SP.Guid, itemId: string): void; + static logAnalyticsAppEvent2(context: SP.ClientRuntimeContext, appEventTypeId: SP.Guid, itemId: string, rollupScopeId: SP.Guid, siteId: SP.Guid, userId: string): void; + } + export enum EventTypeId { + none, + first, + view, + recommendationView, + recommendationClick, + last, + } + } + + export module SiteHealth { + export class SiteHealthResult extends SP.ClientValueObject { + get_messageAsText(): string; + get_ruleHelpLink(): string; + get_ruleId(): SP.Guid; + get_ruleIsRepairable(): bool; + get_ruleName(): string; + get_status(): SP.SiteHealth.SiteHealthStatusType; + set_status(value: SP.SiteHealth.SiteHealthStatusType): void; + get_timeStamp(): Date; + set_timeStamp(value: Date): void; + get_typeId(): string; + writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; + constructor(); + } + export enum SiteHealthStatusType { + passed, + failedWarning, + failedError, + } + export class SiteHealthSummary extends SP.ClientObject { + get_failedErrorCount(): number; + get_failedWarningCount(): number; + get_passedCount(): number; + get_results(): SP.SiteHealth.SiteHealthResult[]; + } + } + +} + + + + +declare module Microsoft.SharePoint.Client.Search { + module Query { + + /**Contains information common to all types of search queries.*/ + export class Query extends SP.ClientObject { + get_blockDedupeMode: () => number; + set_blockDedupeMode: (value: number) => void; + + get_bypassResultTypes: () => bool; + set_bypassResultTypes: (value: bool) => void; + + get_clientType: () => string; + set_clientType: (value: string) => void; + + get_culture: () => number; + set_culture: (value: number) => void; + + get_desiredSnippetLength: () => number; + set_desiredSnippetLength: (value: number) => void; + + get_enableInterleaving: () => bool; + set_enableInterleaving: (value: bool) => void; + + get_enableNicknames: () => bool; + set_enableNicknames: (value: bool) => void; + + get_enableOrderingHitHighlightedProperty: () => bool; + set_enableOrderingHitHighlightedProperty: (value: bool) => void; + + get_enablePhonetic: () => bool; + set_enablePhonetic: (value: bool) => void; + + get_enableQueryRules: () => bool; + set_enableQueryRules: (value: bool) => void; + + get_enableStemming: () => bool; + set_enableStemming: (value: bool) => void; + + get_generateBlockRankLog: () => bool; + set_generateBlockRankLog: (value: bool) => void; + + get_hitHighlightedMultivaluePropertyLimit: () => number; + set_hitHighlightedMultivaluePropertyLimit: (value: number) => void; + + get_hitHighlightedProperties: () => StringCollection; + + get_ignoreSafeQueryPropertiesTemplateUrl: () => bool; + set_ignoreSafeQueryPropertiesTemplateUrl: (value: bool) => void; + + get_impressionID: () => string; + set_impressionID: (value: string) => void; + + get_maxSnippetLength: () => number; + set_maxSnippetLength: (value: number) => void; + + get_personalizationData: () => QueryPersonalizationData; + set_personalizationData: (QueryPersonalizationData) => void; + + get_processBestBets: () => bool; + set_processBestBets: (value: bool) => void; + + get_processPersonalFavorites: () => bool; + set_processPersonalFavorites: (value: bool) => void; + + get_queryTag: () => string; + set_queryTag: (value: string) => void; + + get_queryTemplate: () => string; + set_queryTemplate: (value: string) => void; + + get_queryTemplateParameters: () => { [key: string]: bool; }; + + get_queryText: () => string; + set_queryText: (value: string) => void; + + get_rankingModelId: () => string; + set_rankingModelId: (value: string) => void; + + get_resultsUrl: () => string; + set_resultsUrl: (value: string) => void; + + get_rowLimit: () => number; + set_rowLimit: (value: number) => void; + + get_rowsPerPage: () => number; + set_rowsPerPage: (value: number) => void; + + get_safeQueryPropertiesTemplateUrl: () => string; + set_safeQueryPropertiesTemplateUrl: (value: string) => void; + + get_showPeopleNameSuggestions: () => bool; + set_showPeopleNameSuggestions: (value: bool) => void; + + get_sourceId: () => SP.Guid; + set_sourceId: (value: SP.Guid) => void; + + get_startRow: () => number; + set_startRow: (value: number) => void; + + get_summaryLength: () => number; + set_summaryLength: (number) => void; + + get_timeout: () => number; + set_timeout: (value: number) => void; + + get_totalRowsExactMinimum: () => number; + set_totalRowsExactMinimum: (value: number) => void; + + get_trimDuplicates: () => bool; + set_trimDuplicates: (value: bool) => void; + + + get_uiLanguage: () => number; + set_uiLanguage: (value: number) => void; + + + + getQuerySuggestionsWithResults: (iNumberOfQuerySuggestions: number, + iNumberOfResultSuggestions: number, + fPreQuerySuggestions: bool, + fHitHighlighting: bool, + fCapitalizeFirstLetters: bool, + fPrefixMatchAllTerms: bool) => QuerySuggestionResults; + + + } + + /**Contains information about a keyword based search query.*/ + export class KeywordQuery extends Query { + constructor(context: SP.ClientContext); + + get_collapseSpecification: () => string; + set_collapseSpecification: (value: string) => void; + + get_enableSorting: () => bool; + set_enableSorting: (value: bool) => void; + + get_hiddenConstraints: () => string; + set_hiddenConstraints: (value: string) => void; + + get_properties: () => KeywordQueryProperties; + + get_refinementFilters: () => StringCollection; + set_refinementFilters: (value: StringCollection) => void; + + get_refiners: () => string; + set_refiners: (value: string) => void; + + get_reorderingRules: () => ReorderingRuleCollection; + set_reorderingRules: (value: ReorderingRuleCollection) => void; + + /**Specifies the list of managed properties to be returned for each search result.*/ + get_selectProperties: () => StringCollection; + + get_sortList: () => SortCollection; + + get_trimDuplicatesIncludeId: () => number; + set_trimDuplicatesIncludeId: (value: number) => void; + } + + /**Executes queries against a search server.*/ + export class SearchExecutor extends SP.ClientObject { + constructor(context: SP.ClientContext); + + /**Runs a query.*/ + executeQuery: (query: Query) => SP.JsonObjectResult; + executeQueries: (queryIds: string[], queries: Query[], handleExceptions: bool) => SP.JsonObjectResult; + recordPageClick: ( + pageInfo: string, + clickType: string, + blockType: number, + clickedResultId: string, + subResultIndex: number, + immediacySourceId: string, + immediacyQueryString: string, + immediacyTitle: string, + immediacyUrl: string) => void; + exportPopularQueries: (web: SP.Web, sourceId: SP.Guid) => SP.JsonObjectResult; + } + + + export class StringCollection extends SP.ClientObjectCollection { + constructor(context: SP.ClientContext); + itemAt: (index: number) => string; + get_item: (index: number) => string; + get_childItemType: () => Object; + add: (property: string) => void; + clear: () => void; + } + + export class QueryPersonalizationData extends SP.ClientObject { + //It's really empty; + } + + export class QuerySuggestionResults extends SP.ClientValueObject { + get_peopleNames: () => string[]; + set_peopleNames: (value: string[]) => void; + + get_personalResults: () => PersonalResultSuggestion[]; + set_personalResults: (value: PersonalResultSuggestion[]) => void; + + get_queries: () => QuerySuggestionQuery[]; + set_queries: (value: QuerySuggestionQuery[]) => void; + } + + export class PersonalResultSuggestion extends SP.ClientValueObject { + get_highlightedTitle: () => string; + set_highlightedTitle: (value: string) => void; + + get_isBestBet: () => bool; + set_isBestBet: (value: bool) => void; + + get_title: () => string; + set_title: (value: string) => void; + + get_url: () => string; + set_url: (value: string) => void; + } + + export class QuerySuggestionQuery extends SP.ClientValueObject { + get_isPersonal: () => bool; + set_isPersonal: (value: bool) => void; + + get_query: () => string; + set_query: (value: string) => void; + } + + export class KeywordQueryProperties extends SP.ClientObject { + get_item: (key: string) => any; + set_item: (key: string, value: any) => void; + setQueryPropertyValue: (name: string) => QueryPropertyValue; + getQueryPropertyValue: (name: string, value: QueryPropertyValue) => void; + } + + export enum QueryPropertyValueType { + none, + stringType, + int32TYpe, + booleanType, + stringArrayType, + unSupportedType + } + + export class QueryPropertyValue extends SP.ClientValueObject { + get_boolVal: () => bool; + set_boolVal: (value: bool) => bool; + + get_intVal: () => number; + set_intVal: (value: number) => number; + get_queryPropertyValueTypeIndex: () => number; + set_queryPropertyValueTypeIndex: (value: number) => void; + get_strArray: () => string[]; + set_strArray: (value: string[]) => string[]; + get_strVal: () => string; + set_strVal: (value: string) => string; + } + + export class QueryUtility { + static create: (name: string, val: any) => QueryPropertyValue; + static getQueryPropertyValueType: (val: QueryPropertyValue) => QueryPropertyValueType; + static queryPropertyValueToObject: (val: QueryPropertyValue) => any; + } + export class ReorderingRuleCollection extends SP.ClientObjectCollection { + itemAt: (index: number) => ReorderingRule; + get_item: (index: number) => ReorderingRule; + get_childItemType: () => Object; + add: (property: ReorderingRule) => void; + clear: () => void; + } + + export enum ReorderingRuleMatchType { + resultContainsKeyword, + titleContainsKeyword, + titleMatchesKeyword, + urlStartsWith, + urlExactlyMatches, + contentTypeIs, + fileExtensionMatches, + resultHasTag, + manualCondition + } + + export class ReorderingRule extends SP.ClientValueObject { + get_boost: () => number; + set_boost: (value: number) => void; + + get_matchType: () => ReorderingRuleMatchType; + set_matchType: (value: ReorderingRuleMatchType) => void; + + get_matchValue: () => string; + set_matchValue: (value: string) => void; + } + + export class SortCollection extends SP.ClientObjectCollection { + itemAt: (index: number) => Sort; + get_item: (index: number) => Sort; + get_childItemType: () => Object; + add: (property: Sort) => void; + clear: () => void; + } + + enum SortDirection { + ascending, + descending, + fqlFormula + } + export class Sort extends SP.ClientValueObject { + get_direction: () => SortDirection; + set_direction: (value: SortDirection) => void; + + get_property: () => string; + set_property: (value: string) => void; + } + + + export class ResultTableCollection extends SP.ClientValueObjectCollection { + get_item: (index: number) => ResultTable; + + get_elapsedTime: () => number; + set_elapsedTime: (value: number) => void; + + get_properties: () => { [key: string]: any; }; + + get_queryErrors: () => { [key: string]: WebControls.ControlMessage; }; + + get_queryId: () => string; + + get_spellingSuggestion: () => string; + + get_triggeredRules: () => SP.Guid[]; + + initPropertiesFromJson: (parentNode: any) => void; + + } + + export class ResultTable extends SP.ClientValueObject { + get_groupTemplateId: () => string; + + get_itemTemplateId: () => string; + + get_properties: () => { [key: string]: any; }; + + get_queryId: () => string; + + get_queryRuleId: () => string; + + get_resultRows: () => { [key: string]: any; }[]; + + get_resultTitle: () => string; + + get_resultTitleUrl: () => string; + + get_rowCount: () => number; + + get_tableType: () => string; + + get_totalRows: () => number; + + get_totalRowsIncludingDuplicates: () => number; + + initPropertiesFromJson: (parentNode: any) => void; + } + + export class RankingLabeling extends SP.ClientObject { + constructor(context: SP.ClientContext); + getJudgementsForQuery: (query: string) => SP.JsonObjectResult; + addJudgment: (userQuery: string, url: string, labelId: number) => void; + normalizeResultUrl: (url: string) => SP.JsonObjectResult; + } + + export class PopularQuery extends SP.ClientValueObject { + get_clickCount: () => number; + set_clickCount: (value: number) => void; + + get_LCID: () => number; + set_LCID: (value: number) => void; + + get_queryCount: () => number; + set_queryCount: (value: number) => void; + + get_queryText: () => string; + set_queryText: (value: string) => void; + } + + export class QueryPropertyNames { + static blockDedupeMode: string; // 'BlockDedupeMode'; + static bypassResultTypes: string; // 'BypassResultTypes'; + static clientType: string; // 'ClientType'; + static culture: string; // 'Culture'; + static desiredSnippetLength: string; // 'DesiredSnippetLength'; + static enableInterleaving: string; // 'EnableInterleaving'; + static enableNicknames: string; // 'EnableNicknames'; + static enableOrderingHitHighlightedProperty: string; // 'EnableOrderingHitHighlightedProperty'; + static enablePhonetic: string; // 'EnablePhonetic'; + static enableQueryRules: string; // 'EnableQueryRules'; + static enableStemming: string; // 'EnableStemming'; + static generateBlockRankLog: string; // 'GenerateBlockRankLog'; + static hitHighlightedMultivaluePropertyLimit: string; // 'HitHighlightedMultivaluePropertyLimit'; + static ignoreSafeQueryPropertiesTemplateUrl: string; // 'IgnoreSafeQueryPropertiesTemplateUrl'; + static impressionID: string; // 'ImpressionID'; + static maxSnippetLength: string; // 'MaxSnippetLength'; + static processBestBets: string; // 'ProcessBestBets'; + static processPersonalFavorites: string; // 'ProcessPersonalFavorites'; + static queryTag: string; // 'QueryTag'; + static queryTemplate: string; // 'QueryTemplate'; + static queryTemplateParameters: string; // 'QueryTemplateParameters'; + static queryText: string; // 'QueryText'; + static rankingModelId: string; // 'RankingModelId'; + static resultsUrl: string; // 'ResultsUrl'; + static rowLimit: string; // 'RowLimit'; + static rowsPerPage: string; // 'RowsPerPage'; + static safeQueryPropertiesTemplateUrl: string; // 'SafeQueryPropertiesTemplateUrl'; + static showPeopleNameSuggestions: string; // 'ShowPeopleNameSuggestions'; + static sourceId: string; // 'SourceId'; + static startRow: string; // 'StartRow'; + static summaryLength: string; // 'SummaryLength'; + static timeout: string; // 'Timeout'; + static totalRowsExactMinimum: string; // 'TotalRowsExactMinimum'; + static trimDuplicates: string; // 'TrimDuplicates'; + static uiLanguage: string; // 'UILanguage'; + } + + export class QueryObjectPropertyNames { + static hitHighlightedProperties: string; // = 'HitHighlightedProperties'; + static personalizationData: string; // = 'PersonalizationData'; + } + + export class KeywordQueryPropertyNames { + static collapseSpecification: string; // 'CollapseSpecification'; + static enableSorting: string; // 'EnableSorting'; + static hiddenConstraints: string; // 'HiddenConstraints'; + static refiners: string; // 'Refiners'; + static trimDuplicatesIncludeId: string; // 'TrimDuplicatesIncludeId'; + } + + export class KeywordQueryObjectPropertyNames { + static properties: string; // 'Properties'; + static refinementFilters: string; // 'RefinementFilters'; + static reorderingRules: string; // 'ReorderingRules'; + static selectProperties: string; // 'SelectProperties'; + static sortList: string; // 'SortList'; + } + } + + module WebControls { + export class ControlMessage extends SP.ClientValueObject { + get_code: () => number; + + get_correlationID: () => string; + + get_encodeDetails: () => bool; + + get_header: () => string; + + get_level: () => MessageLevel; + + get_messageDetails: () => string; + + get_messageDetailsForViewers: () => string; + + get_serverTypeId: () => string; + + get_showForViewerUsers: () => bool; + + get_showInEditModeOnly: () => bool; + + get_stackTrace: () => string; + + get_type: () => string; + } + + export enum MessageLevel { + information, + warning, + error + } + } + + module Administration { + export class DocumentCrawlLog extends SP.ClientObject { + constructor(context: SP.ClientContext, site: SP.Site); + getCrawledUrls: (getCountOnly: bool, + maxRows: { High: number; Low: number; }, + queryString: string, + isLike: bool, + contentSourceID: number, + errorLevel: number, + errorID: number, + startDateTime: Date, + endDateTime: Date) => SP.JsonObjectResult; + } + + export class SearchObjectOwner extends SP.ClientObject { + constructor(context: SP.ClientContext, lowestCurrentLevelToUse: SearchObjectLevel); + } + + export enum SearchObjectLevel { + spWeb, + spSite, + spSiteSubscription, + ssa + } + } + + module Portability { + export class SearchConfigurationPortability extends SP.ClientObject { + constructor(context: SP.ClientContext); + get_importWarnings: () => string; + + exportSearchConfiguration: (owningScope: Administration.SearchObjectOwner) => SP.JsonObjectResult; + + importSearchConfiguration: (owningScope: Administration.SearchObjectOwner, searchConfiguration: string) => void; + + deleteSearchConfiguration: (owningScope: Administration.SearchObjectOwner, searchConfiguration: string) => void; + } + + export class SearchConfigurationPortabilityPropertyNames { + static importWarnings: string;// = 'ImportWarnings' + } + } + + /**Located in sp.search.apps.js*/ + module Analytics { + export class AnalyticsItemData extends SP.ClientObject { + get_lastProcessingTime: () => Date; + + get_totalHits: () => number; + + get_totalUniqueUsers: () => number; + + getHitCountForDay: (day: Date) => number; + + getUniqueUsersCountForDay: (day: Date) => number; + + getHitCountForMonth: (day: Date) => number; + + getUniqueUsersCountForMonth: (day: Date) => number; + } + + export class UsageAnalytics extends SP.ClientObject { + getAnalyticsItemData: (eventType: number, listItem: SP.ListItem) => AnalyticsItemData; + + getAnalyticsItemDataForApplicationEventType: (appEventType: SP.Guid, listItem: SP.ListItem) => AnalyticsItemData; + + deleteStandardEventUsageData: (eventType: number) => void; + + deleteCustomEventUsageData: (appEventTypeId: SP.Guid) => void; + } + + + + } +} + +declare module SP { + export module BusinessData { + export class AppBdcCatalog extends SP.ClientObject { + getEntity(namespace: string, name: string): SP.BusinessData.Entity; + getLobSystemProperty(lobSystemName: string, propertyName: string): SP.StringResult; + setLobSystemProperty(lobSystemName: string, propertyName: string, propertyValue: string): void; + getLobSystemInstanceProperty(lobSystemName: string, lobSystemInstanceName: string, propertyName: string): SP.StringResult; + setLobSystemInstanceProperty(lobSystemName: string, lobSystemInstanceName: string, propertyName: string, propertyValue: string): void; + getConnectionId(lobSystemName: string, lobSystemInstanceName: string): SP.StringResult; + setConnectionId(lobSystemName: string, lobSystemInstanceName: string, connectionId: string): void; + getPermissibleConnections(): string[]; + } + export class Entity extends SP.ClientObject { + get_estimatedInstanceCount(): number; + get_name(): string; + get_namespace(): string; + getIdentifiers(): SP.BusinessData.Collections.EntityIdentifierCollection; + getIdentifierCount(): SP.IntResult; + getLobSystem(): SP.BusinessData.LobSystem; + getCreatorView(methodInstanceName: string): SP.BusinessData.EntityView; + getUpdaterView(updaterName: string): SP.BusinessData.EntityView; + getFinderView(methodInstanceName: string): SP.BusinessData.EntityView; + getSpecificFinderView(specificFinderName: string): SP.BusinessData.EntityView; + getDefaultSpecificFinderView(): SP.BusinessData.EntityView; + findSpecificDefault(identity: SP.BusinessData.Runtime.EntityIdentity, lobSystemInstance: SP.BusinessData.LobSystemInstance): SP.BusinessData.Runtime.EntityInstance; + findSpecific(identity: SP.BusinessData.Runtime.EntityIdentity, specificFinderName: string, lobSystemInstance: SP.BusinessData.LobSystemInstance): SP.BusinessData.Runtime.EntityInstance; + findSpecificDefaultByBdcId(bdcIdentity: string, lobSystemInstance: SP.BusinessData.LobSystemInstance): SP.BusinessData.Runtime.EntityInstance; + findSpecificByBdcId(bdcIdentity: string, specificFinderName: string, lobSystemInstance: SP.BusinessData.LobSystemInstance): SP.BusinessData.Runtime.EntityInstance; + findFiltered(filterList: SP.BusinessData.Collections.FilterCollection, nameOfFinder: string, lobSystemInstance: SP.BusinessData.LobSystemInstance): SP.BusinessData.Collections.EntityInstanceCollection; + findAssociated(entityInstance: SP.BusinessData.Runtime.EntityInstance, associationName: string, filterList: SP.BusinessData.Collections.FilterCollection, lobSystemInstance: SP.BusinessData.LobSystemInstance): SP.BusinessData.Collections.EntityInstanceCollection; + getFilters(methodInstanceName: string): SP.BusinessData.Collections.FilterCollection; + execute(methodInstanceName: string, lobSystemInstance: SP.BusinessData.LobSystemInstance, inputParams: any[]): SP.BusinessData.MethodExecutionResult; + getAssociationView(associationName: string): SP.BusinessData.EntityView; + create(fieldValues: SP.BusinessData.Runtime.EntityFieldValueDictionary, lobSystemInstance: SP.BusinessData.LobSystemInstance): SP.BusinessData.Runtime.EntityIdentity; + subscribe(eventType: SP.BusinessData.Runtime.EntityEventType, notificationCallback: SP.BusinessData.Runtime.NotificationCallback, onBehalfOfUser: string, subscriberName: string, lobSystemInstance: SP.BusinessData.LobSystemInstance): SP.BusinessData.Runtime.Subscription; + unsubscribe(subscription: SP.BusinessData.Runtime.Subscription, onBehalfOfUser: string, unsubscriberName: string, lobSystemInstance: SP.BusinessData.LobSystemInstance): void; + } + export class EntityField extends SP.ClientObject { + get_containsLocalizedDisplayName(): bool; + get_defaultDisplayName(): string; + get_localizedDisplayName(): string; + get_name(): string; + } + export class EntityIdentifier extends SP.ClientObject { + get_identifierType(): string; + get_name(): string; + getDefaultDisplayName(): SP.StringResult; + containsLocalizedDisplayName(): SP.BooleanResult; + getLocalizedDisplayName(): SP.StringResult; + } + export class EntityView extends SP.ClientObject { + get_fields(): SP.BusinessData.Collections.EntityFieldCollection; + get_name(): string; + get_relatedSpecificFinderName(): string; + getDefaultValues(): SP.BusinessData.Runtime.EntityFieldValueDictionary; + getXmlSchema(): SP.StringResult; + getTypeDescriptor(fieldDotNotation: string): SP.BusinessData.TypeDescriptor; + getType(fieldDotNotation: string): SP.StringResult; + } + export class Filter extends SP.ClientObject { + get_defaultDisplayName(): string; + get_filterField(): string; + get_filterType(): string; + get_localizedDisplayName(): string; + get_name(): string; + get_valueCount(): number; + } + export class LobSystem extends SP.ClientObject { + get_name(): string; + getLobSystemInstances(): SP.BusinessData.Collections.LobSystemInstanceCollection; + } + export class LobSystemInstance extends SP.ClientObject { + get_name(): string; + } + export class MethodExecutionResult extends SP.ClientObject { + get_returnParameterCollection(): SP.BusinessData.ReturnParameterCollection; + } + export class ReturnParameterCollection extends SP.ClientObjectCollection { + itemAt(index: number): SP.BusinessData.Runtime.EntityFieldValueDictionary; + get_item(index: number): SP.BusinessData.Runtime.EntityFieldValueDictionary; + } + export class TypeDescriptor extends SP.ClientObject { + get_containsReadOnly(): bool; + get_isCollection(): bool; + get_isReadOnly(): bool; + get_name(): string; + get_typeName(): string; + containsLocalizedDisplayName(): SP.BooleanResult; + getLocalizedDisplayName(): SP.StringResult; + getDefaultDisplayName(): SP.StringResult; + isRoot(): SP.BooleanResult; + isLeaf(): SP.BooleanResult; + getChildTypeDescriptors(): SP.BusinessData.Collections.TypeDescriptorCollection; + getParentTypeDescriptor(): SP.BusinessData.TypeDescriptor; + } + export module Collections { + export class EntityFieldCollection extends SP.ClientObjectCollection { + itemAt(index: number): SP.BusinessData.EntityField; + get_item(index: number): SP.BusinessData.EntityField; + } + export class EntityIdentifierCollection extends SP.ClientObjectCollection { + itemAt(index: number): SP.BusinessData.EntityIdentifier; + get_item(index: number): SP.BusinessData.EntityIdentifier; + } + export class EntityInstanceCollection extends SP.ClientObjectCollection { + itemAt(index: number): SP.BusinessData.Runtime.EntityInstance; + get_item(index: number): SP.BusinessData.Runtime.EntityInstance; + } + export class FilterCollection extends SP.ClientObjectCollection { + itemAt(index: number): SP.BusinessData.Filter; + get_item(index: number): SP.BusinessData.Filter; + setFilterValue(inputFilterName: string, valueIndex: number, value: any): void; + } + export class LobSystemInstanceCollection extends SP.ClientObjectCollection { + itemAt(index: number): SP.BusinessData.LobSystemInstance; + get_item(index: number): SP.BusinessData.LobSystemInstance; + } + export class TypeDescriptorCollection extends SP.ClientObjectCollection { + itemAt(index: number): SP.BusinessData.TypeDescriptor; + get_item(index: number): SP.BusinessData.TypeDescriptor; + } + } + + export module Infrastructure { + export class ExternalSubscriptionStore extends SP.ClientObject { + constructor(context: SP.ClientRuntimeContext, web: SP.Web); + static newObject(context: SP.ClientRuntimeContext, web: SP.Web): SP.BusinessData.Infrastructure.ExternalSubscriptionStore; + indexStore(): void; + } + } + + export module Runtime { + export enum EntityEventType { + none, + itemAdded, + itemUpdated, + itemDeleted, + } + export class EntityFieldValueDictionary extends SP.ClientObject { + get_fieldValues(): any; + get_item(fieldName: string): any; + set_item(fieldName: string, value: any): void; + refreshLoad(): void; + fromXml(xml: string): void; + toXml(): SP.StringResult; + createInstance(fieldInstanceDotNotation: string, fieldDotNotation: string): void; + createCollectionInstance(fieldDotNotation: string, size: number): void; + getCollectionSize(fieldDotNotation: string): SP.IntResult; + } + export class EntityIdentity extends SP.ClientObject { + get_fieldValues(): any; + get_item(fieldName: string): any; + constructor(context: SP.ClientRuntimeContext, identifierValues: any[]); + get_identifierCount(): number; + static newObject(context: SP.ClientRuntimeContext, identifierValues: any[]): SP.BusinessData.Runtime.EntityIdentity; + refreshLoad(): void; + } + export class EntityInstance extends SP.ClientObject { + get_fieldValues(): any; + get_item(fieldName: string): any; + set_item(fieldName: string, value: any): void; + refreshLoad(): void; + createInstance(fieldInstanceDotNotation: string, fieldDotNotation: string): void; + createCollectionInstance(fieldDotNotation: string, size: number): void; + getIdentity(): SP.BusinessData.Runtime.EntityIdentity; + deleteObject(): void; + update(): void; + fromXml(xml: string): void; + toXml(): SP.StringResult; + } + export class NotificationCallback extends SP.ClientObject { + constructor(context: SP.ClientRuntimeContext, notificationEndpoint: string); + get_notificationContext(): string; + set_notificationContext(value: string): void; + get_notificationEndpoint(): string; + get_notificationForwarderType(): string; + set_notificationForwarderType(value: string): void; + static newObject(context: SP.ClientRuntimeContext, notificationEndpoint: string): SP.BusinessData.Runtime.NotificationCallback; + } + export class Subscription extends SP.ClientObject { + constructor(context: SP.ClientRuntimeContext, id: any, hash: string); + get_hash(): string; + get_iD(): any; + static newObject(context: SP.ClientRuntimeContext, id: any, hash: string): SP.BusinessData.Runtime.Subscription; + } + } + } +} +declare module SP { + export class SOD { + static execute(fileName: string, functionName: string, args?: any[]): void; + static executeFunc(fileName: string, functionName: string, fn: () => void): void; + static executeOrDelayUntilEventNotified(func: () => void, eventName: string): bool; + static executeOrDelayUntilScriptLoaded(func: () => void, depScriptFileName: string): bool; + static notifyScriptLoadedAndExecuteWaitingJobs(scriptFileName: string): void; + static notifyEventAndExecuteWaitingJobs(eventName: string): void; + static registerSod(fileName: string, url: string): void; + static registerSodDep(fileName: string, dependentFileName: string): void; + } +} + +/** Register function to rerun on partial update in MDS-enabled site.*/ +declare function RegisterModuleInit(scriptFileName: string, initFunc: () => void ): void; + +/** Provides access to url and query string parts.*/ +declare class JSRequest { + /** Query string parts.*/ + static QueryString: { [parameter: string]: string; }; + + /** initializes class.*/ + static EnsureSetup(): void; + + /** Current file name (after last '/' in url).*/ + static FileName: string; + + /** Current file path (before last '/' in url).*/ + static PathName: string; +} + +declare class _spPageContextInfo { + static alertsEnabled: bool; //true + static allowSilverlightPrompt: string; //"True" + static clientServerTimeDelta: number; //-182 + static crossDomainPhotosEnabled: bool; //true + static currentCultureName: string; //"ru-RU" + static currentLanguage: number; //1049 + static currentUICultureName: string; //"ru-RU" + static layoutsUrl: string; //"_layouts/15" + static pageListId: string; //"{06ee6d96-f27f-4160-b6bb-c18f187b18a7}" + static pagePersonalizationScope: string; //1 + static serverRequestPath: string; //"/SPTypeScript/Lists/ConditionalFormattingTasksList/AllItems.aspx" + static siteAbsoluteUrl: string; // "https://gandjustas-7b20d3715e8ed4.sharepoint.com" + static siteClientTag: string; //"0$$15.0.4454.1021" + static siteServerRelativeUrl: string; // "/" + static systemUserKey: string; //"i:0h.f|membership|10033fff84e7cb2b@live.com" + static tenantAppVersion: string; //"0" + static userId: number; //12 + static webAbsoluteUrl: string; //"https://gandjustas-7b20d3715e8ed4.sharepoint.com/SPTypeScript" + static webLanguage: number; //1049 + static webLogoUrl: string; //"/_layouts/15/images/siteIcon.png?rev=23" + static webPermMasks: { High: number; Low: number; }; + static webServerRelativeUrl: string; //"/SPTypeScript" + static webTemplate: string; //"17" + static webTitle: string; //"SPTypeScript" + static webUIVersion: number; //15 +} + +declare function STSHtmlEncode(value: string): string; + +declare function AddEvtHandler(element: HTMLElement, event:string, func: EventListener): void; + +/** Gets query string parameter */ +declare function GetUrlKeyValue(key: string): string; + +declare module SP { + export module Sharing { + export class DocumentSharingManager { + static getRoleDefinition(context: SP.ClientRuntimeContext, role: SP.Sharing.Role): SP.RoleDefinition; + static isDocumentSharingEnabled(context: SP.ClientRuntimeContext, list: SP.List): SP.BooleanResult; + static updateDocumentSharingInfo(context: SP.ClientRuntimeContext, resourceAddress: string, userRoleAssignments: SP.Sharing.UserRoleAssignment[], validateExistingPermissions: bool, additiveMode: bool, sendServerManagedNotification: bool, customMessage: string, includeAnonymousLinksInNotification: bool): SP.Sharing.UserSharingResult[]; + } + export enum Role { + none, + view, + edit, + owner, + } + export class UserRoleAssignment extends SP.ClientValueObject { + get_role(): SP.Sharing.Role; + set_role(value: SP.Sharing.Role): void; + get_userId(): string; + set_userId(value: string): void; + get_typeId(): string; + writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; + constructor(); + } + export class UserSharingResult extends SP.ClientValueObject { + get_allowedRoles(): SP.Sharing.Role[]; + get_currentRole(): SP.Sharing.Role; + get_isUserKnown(): bool; + get_message(): string; + get_status(): bool; + get_user(): string; + get_typeId(): string; + writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; + constructor(); + } + } + +} + +declare module SP { + + export module Social { + /** Identifies an actor as a user, document, site, or tag. */ + export enum SocialActorType { + user, + document, + site, + tag + } + /** Specifies one or more actor types in a query to the server. */ + export enum SocialActorTypes { + none, + users, + documents, + sites, + tags, + /** The set excludes documents and sites that do not have feeds. */ + excludeContentWithoutFeeds, + all + } + /** Specifies whether the action is to navigate to the attachment or to perform some action dependent on the context in which the attachment is presented to the user. */ + export enum SocialAttachmentActionKind { + /** This value specifies that the action is to navigate to the attachment. */ + navigate, + /** This value specifies that the action is dependent on the context that the attachment is displayed to the user. */ + adHocAction + } + + export enum SocialAttachmentKind { + image, + video, + document + } + + /** Specifies whether the item being inserted is a user, document, site, tag, or link. */ + export enum SocialDataItemType { + user, + document, + site, + tag, + link + } + + /** Specifies whether the overlay is a link or one or more actors. */ + export enum SocialDataOverlayType { + link, + actors + } + + /** Specifies whether the sort order is by creation time or modification time. */ + export enum SocialFeedSortOrder { + byModifiedTime, + byCreatedTime + } + + /** Identifies the kind of post to be retrieved. */ + export enum SocialFeedType { + personal, + news, + timeline, + likes, + everyone + } + + // For some reasons this enum doesn't exist + //export enum SocialFollowResult { + // ok = 0, + // alreadyFollowing = 1, + // limitReached = 2, + // internalError = 3 + //} + + /** Provides information about the feed. + This type provides information about whether the feed on the server contains additional threads that were not returned. */ + export enum SocialFeedAttributes { + none, + moreThreadsAvailable + } + + /** Specifies attributes of the post, such as whether the current user can like or delete the post. */ + export enum SocialPostAttributes { + none, + canLike, + canDelete, + useAuthorImage, + useSmallImage, + canFollowUp + } + + /** Defines the type of item being specified in the SocialPostDefinitionDataItem. + This type is only available in server-to-server calls. */ + export enum SocialPostDefinitionDataItemType { + text, + user, + document, + site, + tag, + link + } + + export enum SocialPostType { + root, + reply + } + + /** Specifies a status or error code. */ + export enum SocialStatusCode { + OK, + /** This value specifies that an invalid request was encountered. */ + invalidRequest, + /** This value specifies that access was denied to the current user. */ + accessDenied, + itemNotFound, + /** This value specifies that an invalid operation was attempted. */ + invalidOperation, + /** This value specifies that the item was not changed by the operation. */ + itemNotModified, + internalError, + /** This value specifies that there was an error reading the cache. */ + cacheReadError, + /** This value specifies that there was an error updating the cache. */ + cacheUpdateError, + personalSiteNotFound, + failedToCreatePersonalSite, + notAuthorizedToCreatePersonalSite, + cannotCreatePersonalSite, + /** This value specifies that a server limit was reached. */ + limitReached, + /** This value specifies that the operation failed because there was an error handling an attachment. */ + attachmentError, + /** This value specifies that the operation completed with recoverable errors and that the returned data is incomplete. */ + partialData, + /** This value specifies that the operation failed because a required server feature was disabled by administrative action. */ + featureDisabled + } + + /** Specifies properties of the thread. */ + export enum SocialThreadAttributes { + none, + isDigest, + canReply, + canLock, + isLocked, + replyLimitReached + } + + export enum SocialThreadType { + normal, + likeReference, + replyReference, + mentionReference, + tagReference + } + + /** Contains information about an actor retrieved from server. An actor is a user, document, site, or tag. */ + export class SocialActor extends SP.ClientValueObject { + /** The AccountName property returns the user account name. + This property is only available for social actors of type "user". */ + get_accountName(): string; + /** Identifies whether the actor is a user, document, site, or tag. */ + get_actorType(): SocialActorType; + /** Specifies whether the actor can be followed by the current user. */ + get_canFollow(): bool; + /** Returns the URI of the document or site content. + This property is only available for social actors of type Document or Site. */ + get_contentUri(): string; + get_emailAddress(): string; + /** Returns the URI of the user's followed content folder. + This property is only available for social actors of type "user". */ + get_followedContentUri(): string; + /** Returns the actor's unique identifier. */ + get_id(): string; + /** Returns the URI of the image representing the actor. + This property is only available if actor is User, Document, or Site. */ + get_imageUri(): string; + /** Returns true if the current user is following the actor; otherwise, it returns false. */ + get_isFollowed(): bool; + /** Returns the URI of the library containing the document. + This property is only available for social actors of type "document". */ + get_libraryUri(): string; + /** The Name property returns the actor's display name. */ + get_name(): string; + /** Returns the URI of the user's personal site. + This property is only available for social actors of type "user". */ + get_personalSiteUri(): string; + /** Represents the status of retrieving the actor */ + get_status(): SocialStatusCode; + /** The StatusText property returns the most recent post of the user. + This property is only available for social actors of type "user". */ + get_statusText(): string; + /** Returns the GUID of the tag. + Only available for social actors of type "tag" */ + get_tagGuid(): string; + /** Returns the user's title + This property is only available for social actors of type "user". */ + get_title(): string; + /** Returns the URI of the actor. */ + get_uri(): string; + } + + /** Identifies an actor to the server. An actor can be a user, document, site, or tag. */ + export class SocialActorInfo extends SP.ClientValueObject { + /** User account name. + This property is only available for social actors of type "user". */ + get_accountName(): string; + /** User account name. + This property is only available for social actors of type "user". */ + set_accountName(value: string): string; + /** Identifies whether the actor is a user, document, site, or tag. */ + get_actorType(): SocialActorType; + /** Identifies whether the actor is a user, document, site, or tag. */ + set_actorType(value: SocialActorType): SocialActorType; + /** URI of the document or site content. + This property is only available for social actors of type Document or Site. */ + get_contentUri(): string; + /** URI of the document or site content. + This property is only available for social actors of type Document or Site. */ + set_contentUri(value: string): string; + /** Actor's unique identifier. */ + get_id(): string; + /** Actor's unique identifier. */ + set_id(value: string): string; + /** GUID of the tag. + Only available for social actors of type "tag" */ + get_tagGuid(): string; + /** GUID of the tag. + Only available for social actors of type "tag" */ + set_tagGuid(value: string): string; + } + + /** Represents an image, document preview, or video preview attachment. */ + export class SocialAttachment extends SP.ClientValueObject { + /** Specifies the type of object that the attachment contains. */ + get_attachmentKind(): SocialAttachmentKind; + /** Specifies the type of object that the attachment contains. */ + set_attachmentKind(value: SocialAttachmentKind): SocialAttachmentKind; + /** Specifies the action to take when the user selects the attachment. + This property is only present if the AttachmentKind is Video. */ + get_clickAction(): SocialAttachmentAction; + /** Specifies the action to take when the user selects the attachment. + This property is only present if the AttachmentKind is Video. */ + set_clickAction(value: SocialAttachmentAction): SocialAttachmentAction; + /** Specifies the URI of the attachment content. */ + get_contentUri(): string; + /** Specifies the URI of the attachment content. */ + set_contentUri(value: string): string; + /** Provides a text description of the attachment. */ + get_description(): string; + /** Provides a text description of the attachment. */ + set_description(value: string): string; + /** Specifies the height of the attachment or of the attachment preview. */ + get_height(): number; + /** Specifies the height of the attachment or of the attachment preview. */ + set_height(value: number): number; + /** Specifies the duration of the attachment in seconds. This property is only present if the AttachmentKind is Video. */ + get_length(): number; + /** Specifies the duration of the attachment in seconds. This property is only present if the AttachmentKind is Video. */ + set_length(value: number): number; + /** Provides the attachment name. */ + get_name(): string; + /** Provides the attachment name. */ + set_name(value: string): string; + /** Specifies the URI of the attachment�s preview thumbnail. + This property is only present if the AttachmentKind is Document or Video. */ + get_previewUri(): string; + /** Specifies the URI of the attachment�s preview thumbnail. + This property is only present if the AttachmentKind is Document or Video. */ + set_previewUri(value: string): string; + /** Provides the attachment URI. */ + get_uri(): string; + /** Provides the attachment URI. */ + set_uri(value: string): string; + /** Specifies the width of the attachment or of the attachment preview. */ + get_width(): number; + /** Specifies the width of the attachment or of the attachment preview. */ + set_width(value: number): number; + } + /** Specifies the user actions that are allowed for the attachment object. */ + export class SocialAttachmentAction extends SP.ClientValueObject { + /** Specifies whether the action is to navigate to a URI or an action that is dependent on the context in which the object is presented to the user. */ + get_actionKind(): SocialAttachmentActionKind; + /** Specifies whether the action is to navigate to a URI or an action that is dependent on the context in which the object is presented to the user. */ + set_actionKind(value: SocialAttachmentActionKind): SocialAttachmentActionKind; + /** Specifies the URI associated with the action. */ + get_actionUri(): string; + /** Specifies the URI associated with the action. */ + set_actionUri(value: string): string; + } + + /** Defines a user, document, site, tag, or link to be inserted in a new post. + The SocialPostCreationData class defines the content text that contains substitution strings. + Each substitution string is replaced by a SocialDataItem value. */ + export class SocialDataItem extends SP.ClientValueObject { + /** Identifies the user. */ + get_accountName(): string; + /** Identifies the user. */ + set_accountName(value: string): string; + /** Specifies whether the item being inserted is a user, document, site, tag, or link. */ + get_itemType(): SocialDataItemType; + /** Specifies whether the item being inserted is a user, document, site, tag, or link. */ + set_itemType(value: SocialDataItemType): SocialDataItemType; + /** Identifies the tag. */ + get_tagGuid(): string; + /** Identifies the tag. */ + set_tagGuid(value: string): string; + /** Specifies the plain text to be inserted in the created post. The server can use the specified text or can use text that identifies the item, for example the name specified in a user profile. */ + get_text(): string; + /** Specifies the plain text to be inserted in the created post. The server can use the specified text or can use text that identifies the item, for example the name specified in a user profile. */ + set_text(value: string): string; + /** Identifies the site, document, or link. */ + get_uri(): string; + /** Identifies the site, document, or link. */ + set_uri(value: string): string; + } + + /** 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. */ + export class SocialDataOverlay extends SP.ClientValueObject { + /** 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. */ + get_actorIndexes(): number[]; + /** The Index property specifies the starting position of the overlay in the SocialPostText string */ + get_index(): number; + /** The Length property specifies the number of characters in the overlay. */ + get_length(): number; + /** The LinkUri property specifies the URI of the link. + This property is only available if the get_overlayType() has a value of SocialDataOverlayType.link. */ + get_linkUri(): string; + /** Specifies whether the overlay is a link or one or more actors. */ + get_overlayType(): SocialDataOverlayType; + } + + /** Specifies information about errors that the server has encountered. */ + export class SocialExceptionDetails extends SP.ClientValueObject { + get_internalErrorCode(): number; + get_internalMessage(): string; + get_internalStackTrace(): string; + /** Specifies a type name associated with the internal error if a type name is available. */ + get_internalTypeName(): string; + get_status(): SocialStatusCode; + } + + /** Specifies a feed, which contains an array of SocialThreads, each of which specifies a root SocialPost object and an array of response SocialPost objects. */ + export class SocialFeed extends SP.ClientValueObject { + /** Specifies attributes of the returned feed. + The attributes specify if the requested feed has additional threads that were not included in the returned thread. */ + get_attributes(): SocialFeedAttributes; + /** Returns the date-time of the most recent post that was requested. + The most recent post that was requested can be removed from the feed if the current user does not have access to it. + Consequently, the feed does not always contain the post with the date specified in this property. */ + get_newestProcessed(): string; + /** The OldestProcessed property returns the date-time of the oldest post that was requested. + The oldest post that was requested can be removed from the feed if the current user does not have access to it. + Consequently, the feed does not always contain the post with the date specified in this property */ + get_oldestProcessed(): string; + /** Contains the social threads in the feed. */ + get_threads(): SocialThread[]; + /** Returns the number of mentions of the current user that have been added to the feed on the server since the time that the unread mention count was cleared for the current user. */ + get_unreadMentionCount(): number; + } + + /** Provides access to social feeds. + It provides methods to create posts, delete posts, read posts, and perform other operations on posts. */ + export class SocialFeedManager extends SP.ClientObject { + constructor(); + /** Returns the current user */ + get_owner(): SocialActor; + /** Specifies the URI of the personal site portal. */ + get_personalSitePortalUri(): string; + /** Creates a post in the current user's newsfeed, in the specified user's feed, or in the specified thread. + This method returns a new or a modified thread. + @param targetId Optional, specifies the target of the post. + If this parameter is null, the post is created as a root post in the current user's feed. + If this parameter is set to a site URL or a site actor identification, the post is created as a root post in the specified site feed. + If this parameter is set to a thread identification, the post is created as a reply post in the specified thread. + @param creationData Specifies the format and content of the post. */ + createPost(targetId: string, creationData: SocialPostCreationData): SocialThread; + /** Deletes the specified post. + This method returns a digest of the modified thread. + If the entire thread is deleted, this method returns null. + If the post being deleted is the root post of a thread, all reply posts are also deleted. + @param postId Specifies the post to be deleted. + Corresponds the value returned from SocialPost.get_id(). */ + deletePost(postId: string): SocialThread; + /** Returns the set of users who have liked the specified post. + @param postId Specifies the post being queried for information about users that like the post. + Corresponds the value returned from SocialPost.get_id().*/ + getAllLikers(postId: string): SocialActor[]; + /** Returns a feed for the current user. + The feed consists of an array of message threads. + Each thread consists of a root post and an array of reply posts. */ + getFeed(type: SocialFeedType, options: SocialFeedOptions): SocialFeed; + /** Returns the public feed for a user or for a site. + The feed lists activity by the user and posts created by the server for that user. + For example, the feed can include posts indicating the user's birthday or indicating that the user liked a post. + @param actorId Corresponds to the value returned by SocialActor.get_id(). + If the actorId specifies the current user, this method returns the public feed for the current user. */ + getFeedFor(actorId: string, options: SocialFeedOptions): SocialFeed; + /** Returns the root post and all reply posts in the thread. */ + getFullThread(threadId: string): SocialThread; + /** Returns a feed containing mention reference threads from the current user's personal feed. */ + getMentions(clearUnreadMentions: bool, options: SocialFeedOptions): SocialFeed; + /** Returns the server's count of unread mentions of the current user. + The server maintains a count of unread mentions in posts, but does not track which mentions have been read. + When a new mention is stored on the server, it increments the unread mention for the user specified by the mention. + The unread mention count is cleared by the GetMentions method. */ + getUnreadMentionCount(): SP.IntResult; + /** Specifies that the current user likes the specified post. + Returns a digest thread containing the specified post. + A digest thread contains the root post and a selection of reply posts */ + likePost(postId: string): SocialThread; + /** Specifies that the current user does not like the specified post. + Returns a digest thread containing the specified post. */ + unlikePost(postId: string): SocialThread; + /** Prevents any user from adding a new reply post to the specified thread. + Once a thread is locked, no new reply posts can be added until after the thread has been unlocked with the unlockThread method. + This method returns a digest of the locked thread */ + lockThread(threadId: string): SocialThread; + /** Allows users to add new reply posts to the specified thread. */ + unlockThread(threadId: string): SocialThread; + /** Suppresses activity notifications for the current user of updates to the specified thread. */ + suppressThreadNotifications(threadId: string): void; + /** Creates an image attachment for a future post. */ + createImageAttachment(name: string, description: string, imageData: any): SocialAttachment; + /** Generates a preview for the content specified by the URL. */ + getPreview(itemUrl: string): SocialAttachment; + /** Returns the preview image data for an image attachment. + @param url Specifies the URL of the preview image relative to the personal site portal. + @param key Specifies the URL-encoded key to decrypt the image. + @param iv Specifies the URL-encoded initialization vector for decrypting the image. */ + getPreviewImage(url: string, key: string, iv: string): any; + } + + export class SocialFeedOptions extends SP.ClientObject { + get_maxThreadCount(): number; + set_maxThreadCount(value: number): number; + get_newerThan(): string; + set_newerThan(value: string): string; + get_olderThan(): string; + set_olderThan(value: string): string; + get_sortOrder():SocialFeedSortOrder; + set_sortOrder(value: SocialFeedSortOrder): SocialFeedSortOrder; + } + + /** Provides properties and methods for managing a user's list of followed actors. + Actors can be users, documents, sites, and tags. */ + export class SocialFollowingManager extends SP.ClientObject { + constructor(context: SP.ClientRuntimeContext); + /** URI to a site that lists the current user's followed documents. */ + get_followedDocumentsUri(): string; + /** URI to a site that lists the current user's followed sites. */ + get_followedSitesUri(): string; + /** Adds the specified actor to the current user's list of followed items. + Returns one of the following values, wrapped into the SP.IntResult object: + 0 = ok, + 1 = alreadyFollowing, + 2 = limitReached, + 3 = internalError */ + follow(actor: SocialActorInfo): SP.IntResult; + stopFollowing(actor: SocialActorInfo): SP.BooleanResult; + isFollowed(actor: SocialActorInfo): SP.BooleanResult; + getFollowed(types: SocialActorTypes): SocialActor[]; + getFollowedCount(types: SocialActorTypes): SP.IntResult; + /** Returns the users who are followers of the current user. */ + getFollowers(): SocialActor[]; + getSuggestions(): SocialActor[]; + } + + /** Defines a link that includes a URI and text representation. + This class is used to represent the location of a web site. */ + export class SocialLink extends SP.ClientValueObject { + get_text(): string; + set_text(value: string): string; + get_uri(): string; + set_uri(value: string): string; + } + + /** Specifies a post read from the server. */ + export class SocialPost extends SP.ClientValueObject { + /** Specifies an image, document preview, or video preview attachment */ + get_attachment(): SocialAttachment; + /** Describes attributes about the post, such as whether the current user can delete or like the post. */ + get_attributes(): SocialPostAttributes; + /** Specifies the author of the post as an index to the social thread's Actors array. */ + get_authorIndex(): number; + /** Specifies the date and time that the post was created on the server. */ + get_createdTime(): string; + /** Specifies the unique identifier of the post. */ + get_id(): string; + /** Specifies information about users who like the post. */ + get_likerInfo(): SocialPostActorInfo; + /** Specifies the date and time that the post was last modified on the server. */ + get_modifiedTime(): string; + /** An array of objects in a post, where each object represents a user, document, site, tag, or link. */ + get_overlays(): SocialDataOverlay[]; + /** Specifies whether a post is the root post or a reply post in a thread */ + get_postType(): SocialPostType; + /** Specifies the URI of the image to be displayed with the post. */ + get_preferredImageUri(): string; + /** Specifies the link to a web site associated with the application that created the post. */ + get_source(): SocialLink; + /** Specifies the text of the post. */ + get_text(): string; + } + + /** Specifies a set of users, documents, sites, and tags by an index into the SocialThreadActors array */ + export class SocialPostActorInfo extends SP.ClientValueObject { + get_includesCurrentUser(): bool; + /** Specifies an array of indexes into the SocialThreadActors array. + The server can choose to return a limited set of actors. For example, the server can choose to return a subset of the users that like a post. */ + get_indexes(): number[]; + get_totalCount(): number; + } + + /** Specifies the content of a post in the SocialFeedManager.createPost method. + The post consists of a text message, which can optionally include social tags, mentions of users, and links. */ + export class SocialPostCreationData extends SP.ClientValueObject { + /** Specifies an image, document preview, or video preview to be used in the post. */ + get_attachment(): SocialAttachment; + /** Specifies an image, document preview, or video preview to be used in the post. */ + set_attachment(value: SocialAttachment): SocialAttachment; + /** Specifies an array consisting of social tags, user mentions, links to documents, links to sites, and generic links. + Each element in the array is inserted into the ContentText string if there is a substitution reference to the array element in the string. */ + get_contentItems(): SocialDataItem; + /** Specifies an array consisting of social tags, user mentions, links to documents, links to sites, and generic links. + Each element in the array is inserted into the ContentText string if there is a substitution reference to the array element in the string. */ + set_contentItems(value: SocialDataItem): SocialDataItem; + /** Contains the text body of the post. */ + get_contentText(): string; + /** Contains the text body of the post. + It can optionally contain one or more substitution references to elements in the zero-based ContentItems array. + A substitution reference consists of a series of characters that consist of an open-brace character ({) followed by one of more digits in the range 0 to 9 and terminated by a close-brace character (}). + The substitution reference is replaced by the text value of the element in the in the array at the offset specified by the value of the digits. + For example, the text string "{0}" is replaced by the first element in the ContentItems array. */ + set_contentText(value: string): string; + /** Specifies additional information when creating server-generated posts */ + get_definitionData(): SocialPostDefinitionData; + /** Specifies additional information when creating server-generated posts */ + set_definitionData(value: SocialPostDefinitionData): SocialPostDefinitionData; + /** Specifies the link to a web site associated with the application that created the post */ + get_source(): SocialLink; + /** Specifies the link to a web site associated with the application that created the post */ + set_source(value: SocialLink): SocialLink; + /** Specifies that access to the post SHOULD be restricted to users that have access to the objects identified by the array of URIs */ + get_securityUris(): string[]; + /** Specifies that access to the post SHOULD be restricted to users that have access to the objects identified by the array of URIs */ + set_securityUris(value: string[]): string[]; + /** Indicates whether the post is to be used as the current user's new status message. */ + get_updateStatusText(): bool; + /** Indicates whether the post is to be used as the current user's new status message. */ + set_updateStatusText(value: bool): bool; + } + + /** Provides additional information about server-generated posts. + This type can only be specified in a server-to-server call. */ + export class SocialPostDefinitionData extends SP.ClientValueObject { + get_items(): SocialPostDefinitionDataItem[]; + set_items(value: SocialPostDefinitionDataItem[]): SocialPostDefinitionDataItem[]; + get_name(): string; + set_name(value: string): string; + } + + /** Specifies an item to be inserted in a post by replacing a token in the post definition. + This type can only be specified in a server-to-server call. */ + export class SocialPostDefinitionDataItem extends SP.ClientValueObject { + /** Specifies the name of the user. + This property is only used if the ItemType property specifies that the item is a User. */ + get_accountName(): string; + /** Specifies the name of the user. + This property is only used if the ItemType property specifies that the item is a User. */ + set_accountName(value: string): string; + /** Specifies whether the item being formatted is a text element, a user, a document, a site, a tag, or a link. */ + get_itemType(): SocialPostDefinitionDataItemType; + /** Specifies whether the item being formatted is a text element, a user, a document, a site, a tag, or a link. */ + set_itemType(value: SocialPostDefinitionDataItemType): SocialPostDefinitionDataItemType; + /** Specifies the post definition token to be replaced by the item */ + get_placeholderName(): string; + /** Specifies the post definition token to be replaced by the item */ + set_placeholderName(value: string): string; + /** Specifies the GUID that identifies the tag. + This property is only used if the ItemType property specifies that the item is a Tag. */ + get_tagGuid(): string; + /** Specifies the GUID that identifies the tag. + This property is only used if the ItemType property specifies that the item is a Tag. */ + set_tagGuid(value: string): string; + /** Specifies the text that is substituted for the placeholder */ + get_text(): string; + /** Specifies the text that is substituted for the placeholder */ + set_text(value: string): string; + /** Specifies the URI of the document, site, or link. + This property is only available if the ItemType property specifies that the item is a Document, Link, or Site. */ + get_uri(): string; + /** Specifies the URI of the document, site, or link. + This property is only available if the ItemType property specifies that the item is a Document, Link, or Site. */ + set_uri(value: string): string; + } + + /** Specifies a reference to a post in another thread. + The referenced post can be a post with a tag, a post that is liked, a post that mentions a user, or a post that is a reply. */ + export class SocialPostReference extends SP.ClientValueObject { + /** Provides a digest of the thread containing the referenced post */ + get_digest(): SocialThread; + get_post(): SocialPost; + /** Specifies the unique identifier of the thread containing the referenced post. */ + get_threadId(): string; + /** Specifies the current owner of the thread as an index into the SocialThreadActors array. */ + get_threadOwnerIndex(): number; + } + + /** Specifies a thread that is stored on the server. + The thread contains a root post and zero or more reply posts. */ + export class SocialThread extends SP.ClientValueObject { + /** Specifies the users who have created a post in the returned thread and also contains any users, documents, sites, and tags that are referenced in any of the posts in the returned thread. */ + get_actors(): SocialActor[]; + /** Specifies attributes of the thread, such as whether the current user can reply or lock the thread and whether the thread is a digest of a thread on the server, whether the number of replies has reached the maximum, and whether the thread is locked. */ + get_attributes(): SocialThreadAttributes; + /** Specifies the unique identification of the thread. */ + get_id(): string; + /** Specifies the thread owner as an index into the Actors array. + Typically, the thread owner is the user who created the root post, but the thread owner can be any user included in the Actors array. */ + get_ownerIndex(): number; + /** Specifies a URI that is a permanent reference to the thread, if such a permanent reference is available. */ + get_permalink(): string; + /** Specifies a reference to a post in another thread. + The PostReference property is available only if the ThreadType has a value of ReplyReference, LikeReference, MentionReference, or TagReference. */ + get_postReference(): SocialPostReference; + /** Returns an array of zero or more reply posts. + The server can return a subset of the reply posts that are stored on the server. */ + get_replies(): SocialPost[]; + get_rootPost(): SocialPost; + /** Provides information about conditions that were encountered retrieving the thread that did not prevent the operation from completing. */ + get_status(): SocialStatusCode; + /** Specifies if the thread is a normal thread created by one or more CreatePost calls or a reference post generated by the server when a user replies to a post, likes a post, or creates a post with a tag or mention */ + get_threadType(): SocialThreadType; + get_totalReplyCount(): number; + } + + } + +} +declare module SP { + module Taxonomy { + export enum StringMatchOption { + startsWith, + exactMatch + } + + export enum ChangeItemType { + unknown, + term, + termSet, + group, + termStore, + site + } + + export enum ChangeOperationType { + unknown, + add, + edit, + deleteObject, + move, + copy, + pathChange, + merge, + importObject, + restore + } + + + export class TaxonomySession extends SP.ClientObject { + static getTaxonomySession(context: SP.ClientContext): TaxonomySession; + get_offlineTermStoreNames(): string[]; + get_termStores(): TermStoreCollection; + getTerms(termLabel: string, trimUnavailable: bool): TermCollection; + getTerms(labelMatchInformation: LabelMatchInformation): TermCollection; + updateCache(): void; + getTerm(guid: SP.Guid): Term; + getTermsById(termIds: SP.Guid[]): TermCollection; + getTermsInDefaultLanguage( + termLabel: string, + defaultLabelOnly: bool, + stringMatchOption: StringMatchOption, + resultCollectionSize: number, + trimUnavailable: bool, + trimDeprecated: bool): TermCollection; + + getTermsInWorkingLocale( + termLabel: string, + defaultLabelOnly: bool, + stringMatchOption: StringMatchOption, + resultCollectionSize: number, + trimUnavailable: bool, + trimDeprecated: bool): TermCollection; + + getTermsWithCustomProperty(customPropertyName: string, trimUnavailable: bool): TermCollection; + getTermsWithCustomProperty(customPropertyMatchInformation: CustomPropertyMatchInformation): TermCollection; + getTermSetsByName(termSetName: string, lcid: number): TermSetCollection; + getTermSetsByTermLabel(requiredTermLabels: string[], lcid: number): TermSetCollection; + getDefaultKeywordsTermStore(): TermStore; + getDefaultSiteCollectionTermStore(): TermStore; + } + + export class TermStoreCollection extends SP.ClientObjectCollection { + itemAt(index: number): TermStore; + get_item(index: number): TermStore; + getById(id: SP.Guid): TermStore; + getByName(name: string): TermStore; + } + + export class TermStore extends SP.ClientObject { + get_contentTypePublishingHub(): string; + get_defaultLanguage(): number; + set_defaultLanguage(value: number): void; + get_groups(): TermGroupCollection; + get_hashTagsTermSet(): TermSet; + get_id(): SP.Guid; + get_isOnline(): bool; + get_keywordsTermSet(): TermSet; + get_languages(): number[]; + get_name(): string; + get_orphanedTermsTermSet(): TermSet; + get_systemGroup(): TermGroup; + get_workingLanguage(): number; + set_workingLanguage(value: number): void; + + addLanguage(lcid: number): void; + commitAll(): void; + createGroup(name: string): TermGroup; + createGroup(name: string, groupId: SP.Guid): TermGroup; + + deleteLanguage(lcid: number): void; + + getChanges(changeInformation: ChangeInformation): ChangedItemCollection; + + getGroup(id: SP.Guid): TermGroup; + getTerm(termId: SP.Guid): Term; + getTermInTermSet(termSetId: SP.Guid, termId: SP.Guid): Term; + getTermsById(termIds: SP.Guid[]): TermCollection; + getTerms(termLabel: string, trimUnavailable: bool): TermCollection; + getTerms(labelMatchInformation: LabelMatchInformation): TermCollection; + getTermSetsByName(termSetName: string, lcid: number): TermSetCollection; + getTermSetsByTermLabel(requiredTermLabels: string[], lcid: number): TermSetCollection; + getTermsWithCustomProperty(customPropertyName: string, trimUnavailable: bool): TermCollection; + getTermsWithCustomProperty(customPropertyMatchInformation: CustomPropertyMatchInformation): TermCollection; + + getTermSet(termSetId: SP.Guid): TermSet; + getTermSetsWithCustomProperty(customPropertyMatchInformation: CustomPropertyMatchInformation): TermSetCollection; + rollbackAll(): void; + updateCache(): void; + getSiteCollectionGroup(currentSite: SP.Site, createIfMissing: bool): TermGroup; + updateUsedTermsOnSite(currentSite: SP.Site): void; + } + + export class TaxonomyItem extends SP.ClientObject { + static normalizeName(context: SP.ClientContext, name: string): SP.StringResult; + get_createdDate(): Date; + get_id(): SP.Guid; + get_lastModifiedDate(): Date; + get_name(): string; + set_name(value: string): void; + get_termStore(): TermStore; + deleteObject(): void; + } + + export class TermGroupCollection extends SP.ClientObjectCollection { + itemAt(index: number): TermGroup; + get_item(index: number): TermGroup; + getById(id: SP.Guid): TermGroup; + getByName(name: string): TermGroup; + } + + export class TermGroup extends TaxonomyItem { + get_description(): string; + set_description(value: string): void; + get_isSiteCollectionGroup(): bool; + get_isSystemGroup(): bool; + get_termSets(): TermSetCollection; + createTermSet(name: string, newTermSetId: SP.Guid, lcid: number): TermSet; + exportObject(): SP.StringResult; + getChanges(changeInformation: ChangeInformation): ChangedItemCollection; + getTermSetsWithCustomProperty(customPropertyMatchInformation: CustomPropertyMatchInformation): TermSetCollection; + } + + export class TermSetItem extends TaxonomyItem { + get_customProperties(): { [key: string]: string; }; + get_customSortOrder(): string; + set_customSortOrder(value: string): void; + get_isAvailableForTagging(): bool; + set_isAvailableForTagging(value: bool): void; + get_owner(): string; + set_owner(value: string): void; + get_terms(): TermCollection; + createTerm(name: string, lcid: number, newTermId: SP.Guid): Term; + /*getTerms(pagingLimit: number): TermCollection;*/ //Moved to descendants to void TypeScript errors + reuseTerm(sourceTerm: Term, reuseBranch: bool): Term; + reuseTermWithPinning(sourceTerm: Term): Term; + deleteCustomProperty(name: string): void; + deleteAllCustomProperties(): void; + setCustomProperty(name: string, value: string): void; + } + + export class TermSetCollection extends SP.ClientObjectCollection { + itemAt(index: number): TermSet; + get_item(index: number): TermSet; + getById(id: SP.Guid): TermSet; + getByName(name: string): TermSet; + } + + export class TermSet extends TermSetItem { + get_contact(): string; + set_contact(value: string): void; + get_description(): string; + set_description(value: string): void; + get_group(): TermGroup; + get_isOpenForTermCreation(): bool; + set_isOpenForTermCreation(value: bool): void; + get_stakeholders(): string[]; + addStakeholder(stakeholderName: string): void; + copy(): TermSet; + deleteStakeholder(stakeholderName: string): void; + exportObject(): SP.StringResult; + getAllTerms(): TermCollection; + getChanges(changeInformation: ChangeInformation): ChangedItemCollection; + getTerm(termId: SP.Guid): Term; + getTerms(pagingLimit: number): TermCollection; + getTerms(termLabel: string, trimUnavailable: bool): TermCollection; + getTerms(labelMatchInformation: LabelMatchInformation): TermCollection; + getTermsWithCustomProperty(customPropertyName: string, trimUnavailable: bool): TermCollection; + getTermsWithCustomProperty(customPropertyMatchInformation: CustomPropertyMatchInformation): TermCollection; + move(targetGroup: TermGroup): void; + } + + export class TermCollection extends SP.ClientObjectCollection { + itemAt(index: number): Term; + get_item(index: number): Term; + getById(id: SP.Guid): Term; + getByName(name: string): Term; + } + + export class Term extends TermSetItem { + get_description(): string; + get_isDeprecated(): bool; + get_isKeyword(): bool; + get_isPinned(): bool; + get_isPinnedRoot(): bool; + get_isReused(): bool; + get_isRoot(): bool; + get_isSourceTerm(): bool; + get_labels: LabelCollection; + get_localCustomProperties(): { [key: string]: string; }; + get_mergedTermIds(): SP.Guid[]; + get_parent(): Term; + get_pathOfTerm(): string; + get_pinSourceTermSet(): TermSet; + get_reusedTerms(): TermCollection; + get_sourceTerm(): Term; + get_termsCount(): number; + get_termSet(): TermSet; + get_termSets(): TermSetCollection; + copy(doCopyChildren: bool): Term; + createLabel(labelName: string, lcid: number, isDefault: bool): Label; + deleteLocalCustomProperty(name: string): void; + deleteAllLocalCustomProperties(): void; + deprecate(doDepricate: bool): void; + getAllLabels(lcid: number): LabelCollection; + getDefaultLabel(lcid: number): Label; + getDescription(lcid: number): SP.StringResult; + + getTerms(pagingLimit: number): TermCollection; + getTerms( + termLabel: string, + lcid: number, + defaultLabelOnly: bool, + stringMatchOption: StringMatchOption, + resultCollectionSize: number, + trimUnavailable: bool): TermCollection; + + merge(termToMerge: Term): void; + move(newParnt: TermSetItem): void; + reassignSourceTerm(reusedTerm: Term): void; + setDescription(description: string, lcid: number): void; + setLocalCustomProperty(name: string, value: string): void; + getIsDescendantOf(ancestorTerm: Term): SP.BooleanResult; + getPath(lcid: number): SP.StringResult; + } + + + export class LabelCollection extends SP.ClientObjectCollection