kylefang/DefinitelyTyped
1
0
Fork 0
mirror of https://github.com/zhigang1992/DefinitelyTyped.git synced 2026-06-01 19:45:48 +08:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #26682 from Rick-Kirkham/officeextension-namespace-apis

Browse Source 
add descriptions to OfficeExtension namespace APIs
This commit is contained in:
Nathan Shively-Sanders
2018-06-20 09:26:09 -07:00
committed by GitHub
parent d79df9b5cc feec88f53f
commit 2f52236169
1 changed files with 41 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

50
types/office-js/index.d.ts vendored
View File

@@ -13559,12 +13559,30 @@ declare namespace OfficeExtension {
}
declare namespace OfficeExtension {
/**
* Specifies which properties of an object should be loaded.
*/
interface LoadOption {
/**
* A comma-delimited string, or array of strings, that specifies the properties/relationships to load.
*/
select?: string | string[];
/**
* A comma-delimited string, or array of strings, that specifies the relationships to load.
*/
expand?: string | string[];
/**
* Only usable on collection types. Specifies the maximum number of collection items that can be included in the result.
*/
top?: number;
/**
* Only usable on collection types. Specifies the number of items in the collection that are to be skipped and not included in the result. If top is specified, the result set will start after skipping the specified number of items.
*/
skip?: number;
}
/**
* Provides an option for suppressing an error when the object that is used to set multiple properties tries to set read-only properties.
*/
interface UpdateOptions {
/**
* Throw an error if the passed-in property list includes read-only properties (default = true).
@@ -13592,7 +13610,11 @@ declare namespace OfficeExtension {
/** Request headers */
requestHeaders: { [name: string]: string };
/** Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. */
/** Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
*
* @param object The object whose properties are loaded.
* @param option A comma-delimited string, or array of strings, that specifies the properties/relationships to load, or an {@link Office.OfficeExtension.LoadOption} object.
*/
load(object: ClientObject, option?: string | string[] | LoadOption): void;
/**
@@ -13652,7 +13674,9 @@ declare namespace OfficeExtension {
*/
extendedErrorLogging: boolean;
};
/**
* Provides information about an error.
*/
interface DebugInfo {
/** Error code string, such as "InvalidArgument". */
code: string;
@@ -13660,24 +13684,20 @@ declare namespace OfficeExtension {
message: string;
/** Inner error, if applicable. */
innerError?: DebugInfo | string;
/** The object type and property or method name (or similar information), if available. */
errorLocation?: string;
/**
* The statement that caused the error, if available.
*
* This statement will never contain any potentially-sensitive data and may not match the code exactly as written, but will be a close approximation.
*/
statements?: string;
/**
* The statements that closely precede and follow the statement that caused the error, if available.
*
* These statements will never contain any potentially-sensitive data and may not match the code exactly as written, but will be a close approximation.
*/
surroundingStatements?: string[];
/**
* All statements in the batch request (including any potentially-sensitive information that was specified in the request), if available.
*
@@ -13731,11 +13751,23 @@ declare namespace OfficeExtension {
declare namespace OfficeExtension {
/** Collection of tracked objects, contained within a request context. See "context.trackedObjects" for more information. */
class TrackedObjects {
/** Track a new object for automatic adjustment based on surrounding changes in the document. Only some object types require this. If you are using an object across ".sync" calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you needed to have added the object to the tracked object collection when the object was first created. */
/**
* Track a new object for automatic adjustment based on surrounding changes in the document. Only some object types require this. If you are using an object across ".sync" calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you needed to have added the object to the tracked object collection when the object was first created.
*
* This method also has the following signature:
*
* `add(objects: ClientObject[]): void;` Where objects is an array of objects to be tracked.
*/
add(object: ClientObject): void;
/** Track a new object for automatic adjustment based on surrounding changes in the document. Only some object types require this. If you are using an object across ".sync" calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you needed to have added the object to the tracked object collection when the object was first created. */
/** Track a set of objects for automatic adjustment based on surrounding changes in the document. Only some object types require this. If you are using an object across ".sync" calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you needed to have added the object to the tracked object collection when the object was first created. */
add(objects: ClientObject[]): void;
/** Release the memory associated with an object that was previously added to this collection. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call `context.sync()` before the memory release takes effect. */
/**
* Release the memory associated with an object that was previously added to this collection. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call `context.sync()` before the memory release takes effect.
*
* This method also has the following signature:
*
* `remove(objects: ClientObject[]): void;` Where objects is an array of objects to be removed.
*/
remove(object: ClientObject): void;
/** Release the memory associated with an object that was previously added to this collection. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call `context.sync()` before the memory release takes effect. */
remove(objects: ClientObject[]): void;