diff --git a/types/chai-spies/chai-spies-tests.ts b/types/chai-spies/chai-spies-tests.ts index f5247ba13f..7bc9530164 100644 --- a/types/chai-spies/chai-spies-tests.ts +++ b/types/chai-spies/chai-spies-tests.ts @@ -24,7 +24,12 @@ let array = [ 1, 2, 3 ]; chai.spy.on(array, 'push'); // or you can track multiple object's methods -chai.spy.on(array, 'push', 'pop'); +chai.spy.on(array, ['push', 'pop']); + +// or you can track multiple object's methods +chai.spy.on(array, 'push', function(item) { + array.push(item); +}); array.push(5); @@ -149,4 +154,20 @@ spy.should.not.have.been.called.above(3); expect(spy).to.have.been.called.below(3); expect(spy).to.not.have.been.called.lt(3); spy.should.have.been.called.lt(3); -spy.should.not.have.been.called.below(3); \ No newline at end of file +spy.should.not.have.been.called.below(3); + +// You can also create sandbox +let sb = chai.spy.sandbox(); + +sb.on(array, 'pop', () => { + return 1; +}) + +let one = array.pop(); +expect(one).to.equal(1); + +// Can restore methods in sandbox +sb.restore(); +array.push(2); +let two = array.pop(); +expect(two).to.equal(2); diff --git a/types/chai-spies/index.d.ts b/types/chai-spies/index.d.ts index 75f702ca37..bb37fa8cd4 100644 --- a/types/chai-spies/index.d.ts +++ b/types/chai-spies/index.d.ts @@ -1,6 +1,8 @@ -// Type definitions for chai-spies +// Type definitions for chai-spies 1.0.0 // Project: https://github.com/chaijs/chai-spies // Definitions by: Ilya Kuznetsov +// Harm van der Werf +// Jouni Suorsa // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped /// @@ -21,7 +23,7 @@ declare namespace Chai { * ```ts * expect(spy).to.be.spy; * spy.should.be.spy; - * ``` + * ``` */ spy: Assertion; @@ -32,7 +34,7 @@ declare namespace Chai { * expect(spy).to.have.been.called(); * spy.should.have.been.called(); * ``` - * Note that ```called``` can be used as a chainable method. + * Note that ```called``` can be used as a chainable method. */ called: ChaiSpies.Called; @@ -61,7 +63,32 @@ declare namespace Chai { } declare namespace ChaiSpies { + interface Sandbox { + /** + * #### chai.spy.on (function) + * + * Wraps an object method into spy. All calls will pass through to the original function. + * + * @param {Object} object + * @param {String} methodNames names to spy on + * @param {function} fn replacement function + * @returns function to actually call + */ + on(object: Object, methodNames: string | string[], fn?: (parameters: any[]|any) => any): any; + /** + * #### chai.spy.restore (function) + * + * Restores previously wrapped object's method. + * Restores all spied objects of a sandbox if called without parameters. + * + * @function + * @param {Object} [object] + * @param {String|String[]} [methods] name or names + * @return {Sandbox} Sandbox instance + */ + restore(object?: Object, methodNames?: string | string[]): void; + } interface Spy { /** * #### chai.spy (function) @@ -72,9 +99,9 @@ declare namespace ChaiSpies { * var spy = chai.spy(original) * , e_spy = chai.spy(); * ``` - * @param fn function to spy on. @default ```function () {}``` + * @param fn function to spy on. @default ```function () {}``` * @returns function to actually call - */ + */ (): SpyFunc0Proxy; (fn: SpyFunc0): SpyFunc0Proxy; (fn: SpyFunc1): SpyFunc1Proxy; @@ -107,10 +134,11 @@ declare namespace ChaiSpies { * var spy = chai.spy.on(Array, 'isArray'); * ``` * @param {Object} object - * @param {String} method name to spy on + * @param {String} method names to spy on + * @param {function} fn replacement function * @returns function to actually call - */ - on(object: Object, ...methodNames: string[]): any; + */ + on(object: Object, methodNames: string | string[], fn?: (parameters: any[]|any) => any): any; /** * #### chai.spy.object (function) @@ -123,10 +151,24 @@ declare namespace ChaiSpies { * @param {String[]|Object} method names or method definitions * @returns object with spied methods */ - object(name: string, methods: string[]): any; - object(methods: string[]): any; - object(name: string, methods: T): T; - object(methods: T): T; + object(name: string, methods: string[]): any; + object(methods: string[]): any; + object(name: string, methods: T): T; + object(methods: T): T; + + /** + * #### chai.spy.restore (function) + * + * Restores spy assigned to DEFAULT sandbox + * + * Restores previously wrapped object's method. + * Restores all spied objects of a sandbox if called without parameters. + * + * @param {Object} [object] + * @param {String|String[]} [methods] name or names + * @return {Sandbox} Sandbox instance + */ + restore(object?: Object, methodNames?: string | string[]): void; /** * #### chai.spy.returns (function) @@ -141,6 +183,18 @@ declare namespace ChaiSpies { */ returns(value: T): SpyFunc0Proxy; + + /** + * ### chai.spy.sandbox + * + * Creates a sandbox. + * + * Sandbox is a set of spies. + * Sandbox allows to track methods on objects and restore original methods with on restore call. + * + * @returns {Sandbox} + */ + sandbox(): Sandbox; } interface Called { @@ -158,12 +212,12 @@ declare namespace ChaiSpies { * spy.should.not.have.been.called.once; * ``` */ - once: Chai.Assertion; + once: Chai.Assertion; /** * ####.twice * Assert that a spy has been called exactly twice. - * ```ts + * ```ts * expect(spy).to.have.been.called.twice; * expect(spy).to.not.have.been.called.twice; * spy.should.have.been.called.twice; @@ -215,7 +269,7 @@ declare namespace ChaiSpies { * ```ts * expect(spy).to.have.been.called.above(3); * spy.should.not.have.been.called.above(3); - * ``` + * ``` */ above(n: number): Chai.Assertion; @@ -225,7 +279,7 @@ declare namespace ChaiSpies { * ```ts * expect(spy).to.have.been.called.gt(3); * spy.should.not.have.been.called.gt(3); - * ``` + * ``` */ gt(n: number): Chai.Assertion; @@ -235,7 +289,7 @@ declare namespace ChaiSpies { * ```ts * expect(spy).to.have.been.called.below(3); * spy.should.not.have.been.called.below(3); - * ``` + * ``` */ below(n: number): Chai.Assertion; @@ -245,7 +299,7 @@ declare namespace ChaiSpies { * ```ts * expect(spy).to.have.been.called.lt(3); * spy.should.not.have.been.called.lt(3); - * ``` + * ``` */ lt(n: number): Chai.Assertion; } @@ -301,7 +355,7 @@ declare namespace ChaiSpies { * spy.should.have.been.called.with('foo'); * ``` * Will also pass for ```spy('foo', 'bar')``` and ```spy(); spy('foo')```. - * If used with multiple arguments, assert that a spy has been called with all the given arguments at least once. + * If used with multiple arguments, assert that a spy has been called with all the given arguments at least once. * ```ts * spy('foo', 'bar', 1); * expect(spy).to.have.been.called.with('bar', 'foo'); @@ -389,7 +443,7 @@ declare namespace ChaiSpies { * * Resets __spy object parameters for instantiation and reuse * @returns proxy spy object - */ + */ reset(): this; } @@ -397,77 +451,77 @@ declare namespace ChaiSpies { (): R; } - interface SpyFunc1 { - (a: A1): R; + interface SpyFunc1 { + (a: A1): R; } - interface SpyFunc2 { - (a: A1, b: A2): R; + interface SpyFunc2 { + (a: A1, b: A2): R; } - interface SpyFunc3 { - (a: A1, b: A2, c: A3): R; + interface SpyFunc3 { + (a: A1, b: A2, c: A3): R; } - interface SpyFunc4 { - (a: A1, b: A2, c: A3, d: A4): R; + interface SpyFunc4 { + (a: A1, b: A2, c: A3, d: A4): R; } - interface SpyFunc5 { - (a: A1, b: A2, c: A3, d: A4, e: A5): R; + interface SpyFunc5 { + (a: A1, b: A2, c: A3, d: A4, e: A5): R; } - interface SpyFunc6 { - (a: A1, b: A2, c: A3, d: A4, e: A5, f: A6): R; + interface SpyFunc6 { + (a: A1, b: A2, c: A3, d: A4, e: A5, f: A6): R; } - interface SpyFunc7 { - (a: A1, b: A2, c: A3, d: A4, e: A5, f: A6, g: A7): R; + interface SpyFunc7 { + (a: A1, b: A2, c: A3, d: A4, e: A5, f: A6, g: A7): R; } - interface SpyFunc8 { - (a: A1, b: A2, c: A3, d: A4, e: A5, f: A6, g: A7, h: A8): R; + interface SpyFunc8 { + (a: A1, b: A2, c: A3, d: A4, e: A5, f: A6, g: A7, h: A8): R; } - - interface SpyFunc9 { - (a: A1, b: A2, c: A3, d: A4, e: A5, f: A6, g: A7, h: A8, i: A9): R; + + interface SpyFunc9 { + (a: A1, b: A2, c: A3, d: A4, e: A5, f: A6, g: A7, h: A8, i: A9): R; } - - interface SpyFunc10 { - (a: A1, b: A2, c: A3, d: A4, e: A5, f: A6, g: A7, h: A8, i: A9, j: A10): R; + + interface SpyFunc10 { + (a: A1, b: A2, c: A3, d: A4, e: A5, f: A6, g: A7, h: A8, i: A9, j: A10): R; } interface SpyFunc0Proxy extends SpyFunc0, Resetable { } - interface SpyFunc1Proxy extends SpyFunc1, Resetable { + interface SpyFunc1Proxy extends SpyFunc1, Resetable { } - interface SpyFunc2Proxy extends SpyFunc2, Resetable { + interface SpyFunc2Proxy extends SpyFunc2, Resetable { } - interface SpyFunc3Proxy extends SpyFunc3, Resetable { + interface SpyFunc3Proxy extends SpyFunc3, Resetable { } - interface SpyFunc4Proxy extends SpyFunc4, Resetable { + interface SpyFunc4Proxy extends SpyFunc4, Resetable { } - interface SpyFunc5Proxy extends SpyFunc5, Resetable { + interface SpyFunc5Proxy extends SpyFunc5, Resetable { } - interface SpyFunc6Proxy extends SpyFunc6, Resetable { + interface SpyFunc6Proxy extends SpyFunc6, Resetable { } - interface SpyFunc7Proxy extends SpyFunc7, Resetable { + interface SpyFunc7Proxy extends SpyFunc7, Resetable { } - interface SpyFunc8Proxy extends SpyFunc8, Resetable { + interface SpyFunc8Proxy extends SpyFunc8, Resetable { } - - interface SpyFunc9Proxy extends SpyFunc9, Resetable { + + interface SpyFunc9Proxy extends SpyFunc9, Resetable { } - - interface SpyFunc10Proxy extends SpyFunc10, Resetable { + + interface SpyFunc10Proxy extends SpyFunc10, Resetable { } } diff --git a/types/jquery/index.d.ts b/types/jquery/index.d.ts index 79525510e9..68f6079b87 100644 --- a/types/jquery/index.d.ts +++ b/types/jquery/index.d.ts @@ -37,12 +37,10 @@ declare const $: JQueryStatic; // Used by JQuery.Event type _Event = Event; -// Used by JQuery.Promise3 and JQuery.Promise -type _Promise = Promise; interface JQueryStatic { /** - * @see {@link http://api.jquery.com/jquery.ajax/#jQuery-ajax1} + * @see \`{@link http://api.jquery.com/jquery.ajax/#jQuery-ajax1 }\` * @deprecated Use jQuery.ajaxSetup(options) */ ajaxSettings: JQuery.AjaxSettings; @@ -52,7 +50,7 @@ interface JQueryStatic { * any synchronous or asynchronous function. * * @param beforeStart A function that is called just before the constructor returns. - * @see {@link https://api.jquery.com/jQuery.Deferred/} + * @see \`{@link https://api.jquery.com/jQuery.Deferred/ }\` * @since 1.5 */ Deferred: JQuery.DeferredStatic; @@ -61,7 +59,7 @@ interface JQueryStatic { * Hook directly into jQuery to override how particular CSS properties are retrieved or set, normalize * CSS property naming, or create custom properties. * - * @see {@link https://api.jquery.com/jQuery.cssHooks/} + * @see \`{@link https://api.jquery.com/jQuery.cssHooks/ }\` * @since 1.4.3 */ cssHooks: JQuery.PlainObject>; @@ -69,7 +67,7 @@ interface JQueryStatic { * An object containing all CSS properties that may be used without a unit. The .css() method uses this * object to see if it may append px to unitless values. * - * @see {@link https://api.jquery.com/jQuery.cssNumber/} + * @see \`{@link https://api.jquery.com/jQuery.cssNumber/ }\` * @since 1.4.3 */ cssNumber: JQuery.PlainObject; @@ -78,7 +76,7 @@ interface JQueryStatic { /** * The rate (in milliseconds) at which animations fire. * - * @see {@link https://api.jquery.com/jQuery.fx.interval/} + * @see \`{@link https://api.jquery.com/jQuery.fx.interval/ }\` * @since 1.4.3 * @deprecated 3.0 */ @@ -86,7 +84,7 @@ interface JQueryStatic { /** * Globally disable all animations. * - * @see {@link https://api.jquery.com/jQuery.fx.off/} + * @see \`{@link https://api.jquery.com/jQuery.fx.off/ }\` * @since 1.3 */ off: boolean; @@ -95,7 +93,7 @@ interface JQueryStatic { /** * A Promise-like object (or "thenable") that resolves when the document is ready. * - * @see {@link https://api.jquery.com/jQuery.ready/} + * @see \`{@link https://api.jquery.com/jQuery.ready/ }\` * @since 1.8 */ ready: JQuery.Thenable>; @@ -106,7 +104,7 @@ interface JQueryStatic { * needs, we strongly recommend the use of an external library such as Modernizr instead of dependency * on properties in jQuery.support. * - * @see {@link https://api.jquery.com/jQuery.support/} + * @see \`{@link https://api.jquery.com/jQuery.support/ }\` * @since 1.3 * @deprecated 1.9 */ @@ -119,7 +117,7 @@ interface JQueryStatic { * A string defining a single, standalone, HTML element (e.g.
or
). * @param ownerDocument_attributes A document in which the new elements will be created. * An object of attributes, events, and methods to call on the newly-created element. - * @see {@link https://api.jquery.com/jQuery/} + * @see \`{@link https://api.jquery.com/jQuery/ }\` * @since 1.0 * @since 1.4 */ @@ -129,7 +127,7 @@ interface JQueryStatic { * * @param selector A string containing a selector expression * @param context A DOM Element, Document, or jQuery to use as context - * @see {@link https://api.jquery.com/jQuery/} + * @see \`{@link https://api.jquery.com/jQuery/ }\` * @since 1.0 */ (selector: JQuery.Selector, context: Element | Document | JQuery | undefined): JQuery; @@ -165,7 +163,7 @@ interface JQueryStatic { * @param selector_object_callback A string containing a selector expression * A string of HTML to create on the fly. Note that this parses HTML, not XML. * The function to execute when the DOM is ready. - * @see {@link https://api.jquery.com/jQuery/} + * @see \`{@link https://api.jquery.com/jQuery/ }\` * @since 1.0 */ (selector_object_callback: JQuery.Selector | JQuery.htmlString | ((this: Document, $: JQueryStatic) => void)): JQuery; // tslint:disable-line:unified-signatures @@ -188,7 +186,7 @@ interface JQueryStatic { * A multi-purpose callbacks list object that provides a powerful way to manage callback lists. * * @param flags An optional list of space-separated flags that change how the callback list behaves. - * @see {@link https://api.jquery.com/jQuery.Callbacks/} + * @see \`{@link https://api.jquery.com/jQuery.Callbacks/ }\` * @since 1.7 */ Callbacks(flags?: string): JQuery.Callbacks; @@ -198,7 +196,7 @@ interface JQueryStatic { * @param url A string containing the URL to which the request is sent. * @param settings A set of key/value pairs that configure the Ajax request. All settings are optional. A default can * be set for any option with $.ajaxSetup(). See jQuery.ajax( settings ) below for a complete list of all settings. - * @see {@link https://api.jquery.com/jQuery.ajax/} + * @see \`{@link https://api.jquery.com/jQuery.ajax/ }\` * @since 1.5 */ ajax(url: string, settings?: JQuery.AjaxSettings): JQuery.jqXHR; @@ -207,7 +205,7 @@ interface JQueryStatic { * * @param settings A set of key/value pairs that configure the Ajax request. All settings are optional. A default can * be set for any option with $.ajaxSetup(). - * @see {@link https://api.jquery.com/jQuery.ajax/} + * @see \`{@link https://api.jquery.com/jQuery.ajax/ }\` * @since 1.0 */ ajax(settings?: JQuery.AjaxSettings): JQuery.jqXHR; @@ -217,7 +215,7 @@ interface JQueryStatic { * * @param dataTypes An optional string containing one or more space-separated dataTypes * @param handler A handler to set default values for future Ajax requests. - * @see {@link https://api.jquery.com/jQuery.ajaxPrefilter/} + * @see \`{@link https://api.jquery.com/jQuery.ajaxPrefilter/ }\` * @since 1.5 */ ajaxPrefilter(dataTypes: string, @@ -227,7 +225,7 @@ interface JQueryStatic { * are processed by $.ajax(). * * @param handler A handler to set default values for future Ajax requests. - * @see {@link https://api.jquery.com/jQuery.ajaxPrefilter/} + * @see \`{@link https://api.jquery.com/jQuery.ajaxPrefilter/ }\` * @since 1.5 */ ajaxPrefilter(handler: (options: JQuery.AjaxSettings, originalOptions: JQuery.AjaxSettings, jqXHR: JQuery.jqXHR) => string | void): void; @@ -235,7 +233,7 @@ interface JQueryStatic { * Set default values for future Ajax requests. Its use is not recommended. * * @param options A set of key/value pairs that configure the default Ajax request. All options are optional. - * @see {@link https://api.jquery.com/jQuery.ajaxSetup/} + * @see \`{@link https://api.jquery.com/jQuery.ajaxSetup/ }\` * @since 1.1 */ ajaxSetup(options: JQuery.AjaxSettings): JQuery.AjaxSettings; @@ -244,7 +242,7 @@ interface JQueryStatic { * * @param dataType A string identifying the data type to use * @param handler A handler to return the new transport object to use with the data type provided in the first argument. - * @see {@link https://api.jquery.com/jQuery.ajaxTransport/} + * @see \`{@link https://api.jquery.com/jQuery.ajaxTransport/ }\` * @since 1.5 */ ajaxTransport(dataType: string, @@ -258,7 +256,7 @@ interface JQueryStatic { * * @param container The DOM element that may contain the other element. * @param contained The DOM element that may be contained by (a descendant of) the other element. - * @see {@link https://api.jquery.com/jQuery.contains/} + * @see \`{@link https://api.jquery.com/jQuery.contains/ }\` * @since 1.4 */ contains(container: Element, contained: Element): boolean; @@ -269,7 +267,7 @@ interface JQueryStatic { * * @param element The DOM element to query for the data. * @param key Name of the data stored. - * @see {@link https://api.jquery.com/jQuery.data/} + * @see \`{@link https://api.jquery.com/jQuery.data/ }\` * @since 1.2.3 */ data(element: Element, key: string, undefined: undefined): any; // tslint:disable-line:unified-signatures @@ -279,7 +277,7 @@ interface JQueryStatic { * @param element The DOM element to associate with the data. * @param key A string naming the piece of data to set. * @param value The new data value; this can be any Javascript type except undefined. - * @see {@link https://api.jquery.com/jQuery.data/} + * @see \`{@link https://api.jquery.com/jQuery.data/ }\` * @since 1.2.3 */ data(element: Element, key: string, value: T): T; @@ -289,7 +287,7 @@ interface JQueryStatic { * * @param element The DOM element to query for the data. * @param key Name of the data stored. - * @see {@link https://api.jquery.com/jQuery.data/} + * @see \`{@link https://api.jquery.com/jQuery.data/ }\` * @since 1.2.3 * @since 1.4 */ @@ -299,7 +297,7 @@ interface JQueryStatic { * * @param element A DOM element from which to remove and execute a queued function. * @param queueName A string containing the name of the queue. Defaults to fx, the standard effects queue. - * @see {@link https://api.jquery.com/jQuery.dequeue/} + * @see \`{@link https://api.jquery.com/jQuery.dequeue/ }\` * @since 1.3 */ dequeue(element: Element, queueName?: string): void; @@ -310,7 +308,7 @@ interface JQueryStatic { * * @param array The array to iterate over. * @param callback The function that will be executed on every object. - * @see {@link https://api.jquery.com/jQuery.each/} + * @see \`{@link https://api.jquery.com/jQuery.each/ }\` * @since 1.0 */ each(array: ArrayLike, callback: (this: T, indexInArray: number, value: T) => false | any): ArrayLike; @@ -321,7 +319,7 @@ interface JQueryStatic { * * @param obj The object to iterate over. * @param callback The function that will be executed on every object. - * @see {@link https://api.jquery.com/jQuery.each/} + * @see \`{@link https://api.jquery.com/jQuery.each/ }\` * @since 1.0 */ each(obj: T, callback: (this: T[K], propertyName: K, valueOfProperty: T[K]) => false | any): T; @@ -329,7 +327,7 @@ interface JQueryStatic { * Takes a string and throws an exception containing it. * * @param message The message to send out. - * @see {@link https://api.jquery.com/jQuery.error/} + * @see \`{@link https://api.jquery.com/jQuery.error/ }\` * @since 1.4.1 */ error(message: string): any; @@ -337,7 +335,7 @@ interface JQueryStatic { * Escapes any character that has a special meaning in a CSS selector. * * @param selector A string containing a selector expression to escape. - * @see {@link https://api.jquery.com/jQuery.escapeSelector/} + * @see \`{@link https://api.jquery.com/jQuery.escapeSelector/ }\` * @since 3.0 */ escapeSelector(selector: JQuery.Selector): JQuery.Selector; @@ -346,7 +344,7 @@ interface JQueryStatic { * * @param deep If true, the merge becomes recursive (aka. deep copy). Passing false for this argument is not supported. * @param target The object to extend. It will receive the new properties. - * @see {@link https://api.jquery.com/jQuery.extend/} + * @see \`{@link https://api.jquery.com/jQuery.extend/ }\` * @since 1.1.4 */ extend(deep: true, target: T, object1: U, object2: V, object3: W, object4: X, object5: Y, object6: Z): T & U & V & W & X & Y & Z; @@ -355,7 +353,7 @@ interface JQueryStatic { * * @param deep If true, the merge becomes recursive (aka. deep copy). Passing false for this argument is not supported. * @param target The object to extend. It will receive the new properties. - * @see {@link https://api.jquery.com/jQuery.extend/} + * @see \`{@link https://api.jquery.com/jQuery.extend/ }\` * @since 1.1.4 */ extend(deep: true, target: T, object1: U, object2: V, object3: W, object4: X, object5: Y): T & U & V & W & X & Y; @@ -364,7 +362,7 @@ interface JQueryStatic { * * @param deep If true, the merge becomes recursive (aka. deep copy). Passing false for this argument is not supported. * @param target The object to extend. It will receive the new properties. - * @see {@link https://api.jquery.com/jQuery.extend/} + * @see \`{@link https://api.jquery.com/jQuery.extend/ }\` * @since 1.1.4 */ extend(deep: true, target: T, object1: U, object2: V, object3: W, object4: X): T & U & V & W & X; @@ -373,7 +371,7 @@ interface JQueryStatic { * * @param deep If true, the merge becomes recursive (aka. deep copy). Passing false for this argument is not supported. * @param target The object to extend. It will receive the new properties. - * @see {@link https://api.jquery.com/jQuery.extend/} + * @see \`{@link https://api.jquery.com/jQuery.extend/ }\` * @since 1.1.4 */ extend(deep: true, target: T, object1: U, object2: V, object3: W): T & U & V & W; @@ -382,7 +380,7 @@ interface JQueryStatic { * * @param deep If true, the merge becomes recursive (aka. deep copy). Passing false for this argument is not supported. * @param target The object to extend. It will receive the new properties. - * @see {@link https://api.jquery.com/jQuery.extend/} + * @see \`{@link https://api.jquery.com/jQuery.extend/ }\` * @since 1.1.4 */ extend(deep: true, target: T, object1: U, object2: V): T & U & V; @@ -391,7 +389,7 @@ interface JQueryStatic { * * @param deep If true, the merge becomes recursive (aka. deep copy). Passing false for this argument is not supported. * @param target The object to extend. It will receive the new properties. - * @see {@link https://api.jquery.com/jQuery.extend/} + * @see \`{@link https://api.jquery.com/jQuery.extend/ }\` * @since 1.1.4 */ extend(deep: true, target: T, object1: U): T & U; @@ -400,7 +398,7 @@ interface JQueryStatic { * * @param deep If true, the merge becomes recursive (aka. deep copy). Passing false for this argument is not supported. * @param target The object to extend. It will receive the new properties. - * @see {@link https://api.jquery.com/jQuery.extend/} + * @see \`{@link https://api.jquery.com/jQuery.extend/ }\` * @since 1.1.4 */ extend(deep: true, target: any, object1: any, ...objects: any[]): any; @@ -409,7 +407,7 @@ interface JQueryStatic { * * @param target An object that will receive the new properties if additional objects are passed in or that will * extend the jQuery namespace if it is the sole argument. - * @see {@link https://api.jquery.com/jQuery.extend/} + * @see \`{@link https://api.jquery.com/jQuery.extend/ }\` * @since 1.0 */ extend(target: T, object1: U, object2: V, object3: W, object4: X, object5: Y, object6: Z): T & U & V & W & X & Y & Z; @@ -418,7 +416,7 @@ interface JQueryStatic { * * @param target An object that will receive the new properties if additional objects are passed in or that will * extend the jQuery namespace if it is the sole argument. - * @see {@link https://api.jquery.com/jQuery.extend/} + * @see \`{@link https://api.jquery.com/jQuery.extend/ }\` * @since 1.0 */ extend(target: T, object1: U, object2: V, object3: W, object4: X, object5: Y): T & U & V & W & X & Y; @@ -427,7 +425,7 @@ interface JQueryStatic { * * @param target An object that will receive the new properties if additional objects are passed in or that will * extend the jQuery namespace if it is the sole argument. - * @see {@link https://api.jquery.com/jQuery.extend/} + * @see \`{@link https://api.jquery.com/jQuery.extend/ }\` * @since 1.0 */ extend(target: T, object1: U, object2: V, object3: W, object4: X): T & U & V & W & X; @@ -436,7 +434,7 @@ interface JQueryStatic { * * @param target An object that will receive the new properties if additional objects are passed in or that will * extend the jQuery namespace if it is the sole argument. - * @see {@link https://api.jquery.com/jQuery.extend/} + * @see \`{@link https://api.jquery.com/jQuery.extend/ }\` * @since 1.0 */ extend(target: T, object1: U, object2: V, object3: W): T & U & V & W; @@ -445,7 +443,7 @@ interface JQueryStatic { * * @param target An object that will receive the new properties if additional objects are passed in or that will * extend the jQuery namespace if it is the sole argument. - * @see {@link https://api.jquery.com/jQuery.extend/} + * @see \`{@link https://api.jquery.com/jQuery.extend/ }\` * @since 1.0 */ extend(target: T, object1: U, object2: V): T & U & V; @@ -454,7 +452,7 @@ interface JQueryStatic { * * @param target An object that will receive the new properties if additional objects are passed in or that will * extend the jQuery namespace if it is the sole argument. - * @see {@link https://api.jquery.com/jQuery.extend/} + * @see \`{@link https://api.jquery.com/jQuery.extend/ }\` * @since 1.0 */ extend(target: T, object1: U): T & U; @@ -463,7 +461,7 @@ interface JQueryStatic { * * @param target An object that will receive the new properties if additional objects are passed in or that will * extend the jQuery namespace if it is the sole argument. - * @see {@link https://api.jquery.com/jQuery.extend/} + * @see \`{@link https://api.jquery.com/jQuery.extend/ }\` * @since 1.0 */ extend(target: any, object1: any, ...objects: any[]): any; @@ -475,7 +473,7 @@ interface JQueryStatic { * @param success A callback function that is executed if the request succeeds. Required if dataType is provided, but * you can use null or jQuery.noop as a placeholder. * @param dataType The type of data expected from the server. Default: Intelligent Guess (xml, json, script, text, html). - * @see {@link https://api.jquery.com/jQuery.get/} + * @see \`{@link https://api.jquery.com/jQuery.get/ }\` * @since 1.0 */ get(url: string, @@ -489,7 +487,7 @@ interface JQueryStatic { * @param success A callback function that is executed if the request succeeds. Required if dataType is provided, but * you can use null or jQuery.noop as a placeholder. * @param dataType The type of data expected from the server. Default: Intelligent Guess (xml, json, script, text, html). - * @see {@link https://api.jquery.com/jQuery.get/} + * @see \`{@link https://api.jquery.com/jQuery.get/ }\` * @since 1.0 */ get(url: string, @@ -502,7 +500,7 @@ interface JQueryStatic { * @param success_data A callback function that is executed if the request succeeds. Required if dataType is provided, but * you can use null or jQuery.noop as a placeholder. * A plain object or string that is sent to the server with the request. - * @see {@link https://api.jquery.com/jQuery.get/} + * @see \`{@link https://api.jquery.com/jQuery.get/ }\` * @since 1.0 */ get(url: string, @@ -514,7 +512,7 @@ interface JQueryStatic { * A set of key/value pairs that configure the Ajax request. All properties except for url are * optional. A default can be set for any option with $.ajaxSetup(). See jQuery.ajax( settings ) for a * complete list of all settings. The type option will automatically be set to GET. - * @see {@link https://api.jquery.com/jQuery.get/} + * @see \`{@link https://api.jquery.com/jQuery.get/ }\` * @since 1.0 * @since 1.12 * @since 2.2 @@ -526,7 +524,7 @@ interface JQueryStatic { * @param url A string containing the URL to which the request is sent. * @param data A plain object or string that is sent to the server with the request. * @param success A callback function that is executed if the request succeeds. - * @see {@link https://api.jquery.com/jQuery.getJSON/} + * @see \`{@link https://api.jquery.com/jQuery.getJSON/ }\` * @since 1.0 */ getJSON(url: string, @@ -538,7 +536,7 @@ interface JQueryStatic { * @param url A string containing the URL to which the request is sent. * @param success_data A callback function that is executed if the request succeeds. * A plain object or string that is sent to the server with the request. - * @see {@link https://api.jquery.com/jQuery.getJSON/} + * @see \`{@link https://api.jquery.com/jQuery.getJSON/ }\` * @since 1.0 */ getJSON(url: string, @@ -548,7 +546,7 @@ interface JQueryStatic { * * @param url A string containing the URL to which the request is sent. * @param success A callback function that is executed if the request succeeds. - * @see {@link https://api.jquery.com/jQuery.getScript/} + * @see \`{@link https://api.jquery.com/jQuery.getScript/ }\` * @since 1.0 */ getScript(url: string, @@ -557,7 +555,7 @@ interface JQueryStatic { * Execute some JavaScript code globally. * * @param code The JavaScript code to execute. - * @see {@link https://api.jquery.com/jQuery.globalEval/} + * @see \`{@link https://api.jquery.com/jQuery.globalEval/ }\` * @since 1.0.4 */ globalEval(code: string): void; @@ -570,7 +568,7 @@ interface JQueryStatic { * @param invert If "invert" is false, or not provided, then the function returns an array consisting of all elements * for which "callback" returns true. If "invert" is true, then the function returns an array * consisting of all elements for which "callback" returns false. - * @see {@link https://api.jquery.com/jQuery.grep/} + * @see \`{@link https://api.jquery.com/jQuery.grep/ }\` * @since 1.0 */ grep(array: ArrayLike, @@ -580,7 +578,7 @@ interface JQueryStatic { * Determine whether an element has any jQuery data associated with it. * * @param element A DOM element to be checked for data. - * @see {@link https://api.jquery.com/jQuery.hasData/} + * @see \`{@link https://api.jquery.com/jQuery.hasData/ }\` * @since 1.5 */ hasData(element: Element): boolean; @@ -588,7 +586,7 @@ interface JQueryStatic { * Holds or releases the execution of jQuery's ready event. * * @param hold Indicates whether the ready hold is being requested or released - * @see {@link https://api.jquery.com/jQuery.holdReady/} + * @see \`{@link https://api.jquery.com/jQuery.holdReady/ }\` * @since 1.6 * @deprecated 3.2 */ @@ -597,7 +595,7 @@ interface JQueryStatic { * Modify and filter HTML strings passed through jQuery manipulation methods. * * @param html The HTML string on which to operate. - * @see {@link https://api.jquery.com/jQuery.htmlPrefilter/} + * @see \`{@link https://api.jquery.com/jQuery.htmlPrefilter/ }\` * @since 1.12/2.2 */ htmlPrefilter(html: JQuery.htmlString): JQuery.htmlString; @@ -607,7 +605,7 @@ interface JQueryStatic { * @param value The value to search for. * @param array An array through which to search. * @param fromIndex The index of the array at which to begin the search. The default is 0, which will search the whole array. - * @see {@link https://api.jquery.com/jQuery.inArray/} + * @see \`{@link https://api.jquery.com/jQuery.inArray/ }\` * @since 1.2 */ inArray(value: T, array: T[], fromIndex?: number): number; @@ -615,7 +613,7 @@ interface JQueryStatic { * Determine whether the argument is an array. * * @param obj Object to test whether or not it is an array. - * @see {@link https://api.jquery.com/jQuery.isArray/} + * @see \`{@link https://api.jquery.com/jQuery.isArray/ }\` * @since 1.3 * @deprecated 3.2 */ @@ -624,7 +622,7 @@ interface JQueryStatic { * Check to see if an object is empty (contains no enumerable properties). * * @param obj The object that will be checked to see if it's empty. - * @see {@link https://api.jquery.com/jQuery.isEmptyObject/} + * @see \`{@link https://api.jquery.com/jQuery.isEmptyObject/ }\` * @since 1.4 */ isEmptyObject(obj: any): boolean; @@ -632,7 +630,7 @@ interface JQueryStatic { * Determine if the argument passed is a JavaScript function object. * * @param obj Object to test whether or not it is a function. - * @see {@link https://api.jquery.com/jQuery.isFunction/} + * @see \`{@link https://api.jquery.com/jQuery.isFunction/ }\` * @since 1.2 * @deprecated 3.3 */ @@ -641,7 +639,7 @@ interface JQueryStatic { * Determines whether its argument represents a JavaScript number. * * @param value The value to be tested. - * @see {@link https://api.jquery.com/jQuery.isNumeric/} + * @see \`{@link https://api.jquery.com/jQuery.isNumeric/ }\` * @since 1.7 * @deprecated 3.3 */ @@ -650,7 +648,7 @@ interface JQueryStatic { * Check to see if an object is a plain object (created using "{}" or "new Object"). * * @param obj The object that will be checked to see if it's a plain object. - * @see {@link https://api.jquery.com/jQuery.isPlainObject/} + * @see \`{@link https://api.jquery.com/jQuery.isPlainObject/ }\` * @since 1.4 */ isPlainObject(obj: any): obj is JQuery.PlainObject; @@ -658,7 +656,7 @@ interface JQueryStatic { * Determine whether the argument is a window. * * @param obj Object to test whether or not it is a window. - * @see {@link https://api.jquery.com/jQuery.isWindow/} + * @see \`{@link https://api.jquery.com/jQuery.isWindow/ }\` * @since 1.4.3 * @deprecated 3.3 */ @@ -667,7 +665,7 @@ interface JQueryStatic { * Check to see if a DOM node is within an XML document (or is an XML document). * * @param node The DOM node that will be checked to see if it's in an XML document. - * @see {@link https://api.jquery.com/jQuery.isXMLDoc/} + * @see \`{@link https://api.jquery.com/jQuery.isXMLDoc/ }\` * @since 1.1.4 */ isXMLDoc(node: Node): boolean; @@ -675,7 +673,7 @@ interface JQueryStatic { * Convert an array-like object into a true JavaScript array. * * @param obj Any object to turn into a native Array. - * @see {@link https://api.jquery.com/jQuery.makeArray/} + * @see \`{@link https://api.jquery.com/jQuery.makeArray/ }\` * @since 1.2 */ makeArray(obj: ArrayLike): T[]; @@ -686,7 +684,7 @@ interface JQueryStatic { * @param callback The function to process each item against. The first argument to the function is the array item, the * second argument is the index in array The function can return any value. A returned array will be * flattened into the resulting array. Within the function, this refers to the global (window) object. - * @see {@link https://api.jquery.com/jQuery.map/} + * @see \`{@link https://api.jquery.com/jQuery.map/ }\` * @since 1.0 */ map(array: T[], callback: (this: Window, elementOfArray: T, indexInArray: number) => JQuery.TypeOrArray | null | undefined): TReturn[]; @@ -698,7 +696,7 @@ interface JQueryStatic { * second argument is the key of the object property. The function can return any value to add to the * array. A returned array will be flattened into the resulting array. Within the function, this refers * to the global (window) object. - * @see {@link https://api.jquery.com/jQuery.map/} + * @see \`{@link https://api.jquery.com/jQuery.map/ }\` * @since 1.6 */ map(obj: T, callback: (this: Window, propertyOfObject: T[K], key: K) => JQuery.TypeOrArray | null | undefined): TReturn[]; @@ -707,7 +705,7 @@ interface JQueryStatic { * * @param first The first array-like object to merge, the elements of second added. * @param second The second array-like object to merge into the first, unaltered. - * @see {@link https://api.jquery.com/jQuery.merge/} + * @see \`{@link https://api.jquery.com/jQuery.merge/ }\` * @since 1.0 */ merge(first: ArrayLike, second: ArrayLike): Array; @@ -715,21 +713,21 @@ interface JQueryStatic { * Relinquish jQuery's control of the $ variable. * * @param removeAll A Boolean indicating whether to remove all jQuery variables from the global scope (including jQuery itself). - * @see {@link https://api.jquery.com/jQuery.noConflict/} + * @see \`{@link https://api.jquery.com/jQuery.noConflict/ }\` * @since 1.0 */ noConflict(removeAll?: boolean): this; /** * An empty function. * - * @see {@link https://api.jquery.com/jQuery.noop/} + * @see \`{@link https://api.jquery.com/jQuery.noop/ }\` * @since 1.4 */ noop(): undefined; /** * Return a number representing the current time. * - * @see {@link https://api.jquery.com/jQuery.now/} + * @see \`{@link https://api.jquery.com/jQuery.now/ }\` * @since 1.4.3 * @deprecated 3.3 Use Date.now(). */ @@ -741,7 +739,7 @@ interface JQueryStatic { * * @param obj An array, a plain object, or a jQuery object to serialize. * @param traditional A Boolean indicating whether to perform a traditional "shallow" serialization. - * @see {@link https://api.jquery.com/jQuery.param/} + * @see \`{@link https://api.jquery.com/jQuery.param/ }\` * @since 1.2 * @since 1.4 */ @@ -752,7 +750,7 @@ interface JQueryStatic { * @param data HTML string to be parsed * @param context Document element to serve as the context in which the HTML fragment will be created * @param keepScripts A Boolean indicating whether to include scripts passed in the HTML string - * @see {@link https://api.jquery.com/jQuery.parseHTML/} + * @see \`{@link https://api.jquery.com/jQuery.parseHTML/ }\` * @since 1.8 */ parseHTML(data: string, context: Document | null | undefined, keepScripts: boolean): JQuery.Node[]; @@ -762,7 +760,7 @@ interface JQueryStatic { * @param data HTML string to be parsed * @param context_keepScripts Document element to serve as the context in which the HTML fragment will be created * A Boolean indicating whether to include scripts passed in the HTML string - * @see {@link https://api.jquery.com/jQuery.parseHTML/} + * @see \`{@link https://api.jquery.com/jQuery.parseHTML/ }\` * @since 1.8 */ parseHTML(data: string, context_keepScripts?: Document | null | boolean): JQuery.Node[]; @@ -770,7 +768,7 @@ interface JQueryStatic { * Takes a well-formed JSON string and returns the resulting JavaScript value. * * @param json The JSON string to parse. - * @see {@link https://api.jquery.com/jQuery.parseJSON/} + * @see \`{@link https://api.jquery.com/jQuery.parseJSON/ }\` * @since 1.4.1 * @deprecated 3.0 */ @@ -779,7 +777,7 @@ interface JQueryStatic { * Parses a string into an XML document. * * @param data a well-formed XML string to be parsed - * @see {@link https://api.jquery.com/jQuery.parseXML/} + * @see \`{@link https://api.jquery.com/jQuery.parseXML/ }\` * @since 1.5 */ parseXML(data: string): XMLDocument; @@ -791,7 +789,7 @@ interface JQueryStatic { * @param success A callback function that is executed if the request succeeds. Required if dataType is provided, but * can be null in that case. * @param dataType The type of data expected from the server. Default: Intelligent Guess (xml, json, script, text, html). - * @see {@link https://api.jquery.com/jQuery.post/} + * @see \`{@link https://api.jquery.com/jQuery.post/ }\` * @since 1.0 */ post(url: string, @@ -805,7 +803,7 @@ interface JQueryStatic { * @param success A callback function that is executed if the request succeeds. Required if dataType is provided, but * can be null in that case. * @param dataType The type of data expected from the server. Default: Intelligent Guess (xml, json, script, text, html). - * @see {@link https://api.jquery.com/jQuery.post/} + * @see \`{@link https://api.jquery.com/jQuery.post/ }\` * @since 1.0 */ post(url: string, @@ -818,7 +816,7 @@ interface JQueryStatic { * @param success_data A callback function that is executed if the request succeeds. Required if dataType is provided, but * can be null in that case. * A plain object or string that is sent to the server with the request. - * @see {@link https://api.jquery.com/jQuery.post/} + * @see \`{@link https://api.jquery.com/jQuery.post/ }\` * @since 1.0 */ post(url: string, @@ -830,7 +828,7 @@ interface JQueryStatic { * A set of key/value pairs that configure the Ajax request. All properties except for url are * optional. A default can be set for any option with $.ajaxSetup(). See jQuery.ajax( settings ) for a * complete list of all settings. Type will automatically be set to POST. - * @see {@link https://api.jquery.com/jQuery.post/} + * @see \`{@link https://api.jquery.com/jQuery.post/ }\` * @since 1.0 * @since 1.12 * @since 2.2 @@ -850,7 +848,7 @@ interface JQueryStatic { * * @param fn The function whose context will be changed. * @param context The object to which the context (this) of the function should be set. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.9 * @deprecated 3.3 Use Function#bind. */ @@ -863,7 +861,7 @@ interface JQueryStatic { * * @param fn The function whose context will be changed. * @param context The object to which the context (this) of the function should be set. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.9 * @deprecated 3.3 Use Function#bind. */ @@ -876,7 +874,7 @@ interface JQueryStatic { * * @param fn The function whose context will be changed. * @param context The object to which the context (this) of the function should be set. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.9 * @deprecated 3.3 Use Function#bind. */ @@ -889,7 +887,7 @@ interface JQueryStatic { * * @param fn The function whose context will be changed. * @param context The object to which the context (this) of the function should be set. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.9 * @deprecated 3.3 Use Function#bind. */ @@ -902,7 +900,7 @@ interface JQueryStatic { * * @param fn The function whose context will be changed. * @param context The object to which the context (this) of the function should be set. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.9 * @deprecated 3.3 Use Function#bind. */ @@ -915,7 +913,7 @@ interface JQueryStatic { * * @param fn The function whose context will be changed. * @param context The object to which the context (this) of the function should be set. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.9 * @deprecated 3.3 Use Function#bind. */ @@ -928,7 +926,7 @@ interface JQueryStatic { * * @param fn The function whose context will be changed. * @param context The object to which the context (this) of the function should be set. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4` * @since 1.6 * @deprecated 3.3 Use Function#bind. @@ -942,7 +940,7 @@ interface JQueryStatic { * * @param fn The function whose context will be changed. * @param context The object to which the context (this) of the function should be set. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.9 * @deprecated 3.3 Use Function#bind. */ @@ -958,7 +956,7 @@ interface JQueryStatic { * * @param fn The function whose context will be changed. * @param context The object to which the context (this) of the function should be set. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.9 * @deprecated 3.3 Use Function#bind. */ @@ -973,7 +971,7 @@ interface JQueryStatic { * * @param fn The function whose context will be changed. * @param context The object to which the context (this) of the function should be set. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.9 * @deprecated 3.3 Use Function#bind. */ @@ -988,7 +986,7 @@ interface JQueryStatic { * * @param fn The function whose context will be changed. * @param context The object to which the context (this) of the function should be set. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.9 * @deprecated 3.3 Use Function#bind. */ @@ -1003,7 +1001,7 @@ interface JQueryStatic { * * @param fn The function whose context will be changed. * @param context The object to which the context (this) of the function should be set. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.9 * @deprecated 3.3 Use Function#bind. */ @@ -1018,7 +1016,7 @@ interface JQueryStatic { * * @param fn The function whose context will be changed. * @param context The object to which the context (this) of the function should be set. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.9 * @deprecated 3.3 Use Function#bind. */ @@ -1033,7 +1031,7 @@ interface JQueryStatic { * * @param fn The function whose context will be changed. * @param context The object to which the context (this) of the function should be set. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.9 * @deprecated 3.3 Use Function#bind. */ @@ -1048,7 +1046,7 @@ interface JQueryStatic { * * @param fn The function whose context will be changed. * @param context The object to which the context (this) of the function should be set. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.9 * @deprecated 3.3 Use Function#bind. */ @@ -1063,7 +1061,7 @@ interface JQueryStatic { * * @param fn The function whose context will be changed. * @param context The object to which the context (this) of the function should be set. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.9 * @deprecated 3.3 Use Function#bind. */ @@ -1080,7 +1078,7 @@ interface JQueryStatic { * * @param fn The function whose context will be changed. * @param context The object to which the context (this) of the function should be set. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.9 * @deprecated 3.3 Use Function#bind. */ @@ -1095,7 +1093,7 @@ interface JQueryStatic { * * @param fn The function whose context will be changed. * @param context The object to which the context (this) of the function should be set. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.9 * @deprecated 3.3 Use Function#bind. */ @@ -1110,7 +1108,7 @@ interface JQueryStatic { * * @param fn The function whose context will be changed. * @param context The object to which the context (this) of the function should be set. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.9 * @deprecated 3.3 Use Function#bind. */ @@ -1125,7 +1123,7 @@ interface JQueryStatic { * * @param fn The function whose context will be changed. * @param context The object to which the context (this) of the function should be set. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.9 * @deprecated 3.3 Use Function#bind. */ @@ -1140,7 +1138,7 @@ interface JQueryStatic { * * @param fn The function whose context will be changed. * @param context The object to which the context (this) of the function should be set. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.9 * @deprecated 3.3 Use Function#bind. */ @@ -1155,7 +1153,7 @@ interface JQueryStatic { * * @param fn The function whose context will be changed. * @param context The object to which the context (this) of the function should be set. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.9 * @deprecated 3.3 Use Function#bind. */ @@ -1170,7 +1168,7 @@ interface JQueryStatic { * * @param fn The function whose context will be changed. * @param context The object to which the context (this) of the function should be set. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.9 * @deprecated 3.3 Use Function#bind. */ @@ -1185,7 +1183,7 @@ interface JQueryStatic { * * @param fn The function whose context will be changed. * @param context The object to which the context (this) of the function should be set. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.9 * @deprecated 3.3 Use Function#bind. */ @@ -1202,7 +1200,7 @@ interface JQueryStatic { * * @param fn The function whose context will be changed. * @param context The object to which the context (this) of the function should be set. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.9 * @deprecated 3.3 Use Function#bind. */ @@ -1217,7 +1215,7 @@ interface JQueryStatic { * * @param fn The function whose context will be changed. * @param context The object to which the context (this) of the function should be set. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.9 * @deprecated 3.3 Use Function#bind. */ @@ -1232,7 +1230,7 @@ interface JQueryStatic { * * @param fn The function whose context will be changed. * @param context The object to which the context (this) of the function should be set. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.9 * @deprecated 3.3 Use Function#bind. */ @@ -1247,7 +1245,7 @@ interface JQueryStatic { * * @param fn The function whose context will be changed. * @param context The object to which the context (this) of the function should be set. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.9 * @deprecated 3.3 Use Function#bind. */ @@ -1262,7 +1260,7 @@ interface JQueryStatic { * * @param fn The function whose context will be changed. * @param context The object to which the context (this) of the function should be set. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.9 * @deprecated 3.3 Use Function#bind. */ @@ -1277,7 +1275,7 @@ interface JQueryStatic { * * @param fn The function whose context will be changed. * @param context The object to which the context (this) of the function should be set. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.9 * @deprecated 3.3 Use Function#bind. */ @@ -1292,7 +1290,7 @@ interface JQueryStatic { * * @param fn The function whose context will be changed. * @param context The object to which the context (this) of the function should be set. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.9 * @deprecated 3.3 Use Function#bind. */ @@ -1307,7 +1305,7 @@ interface JQueryStatic { * * @param fn The function whose context will be changed. * @param context The object to which the context (this) of the function should be set. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.9 * @deprecated 3.3 Use Function#bind. */ @@ -1324,7 +1322,7 @@ interface JQueryStatic { * * @param fn The function whose context will be changed. * @param context The object to which the context (this) of the function should be set. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.9 * @deprecated 3.3 Use Function#bind. */ @@ -1339,7 +1337,7 @@ interface JQueryStatic { * * @param fn The function whose context will be changed. * @param context The object to which the context (this) of the function should be set. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.9 * @deprecated 3.3 Use Function#bind. */ @@ -1354,7 +1352,7 @@ interface JQueryStatic { * * @param fn The function whose context will be changed. * @param context The object to which the context (this) of the function should be set. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.9 * @deprecated 3.3 Use Function#bind. */ @@ -1369,7 +1367,7 @@ interface JQueryStatic { * * @param fn The function whose context will be changed. * @param context The object to which the context (this) of the function should be set. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.9 * @deprecated 3.3 Use Function#bind. */ @@ -1384,7 +1382,7 @@ interface JQueryStatic { * * @param fn The function whose context will be changed. * @param context The object to which the context (this) of the function should be set. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.9 * @deprecated 3.3 Use Function#bind. */ @@ -1399,7 +1397,7 @@ interface JQueryStatic { * * @param fn The function whose context will be changed. * @param context The object to which the context (this) of the function should be set. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.9 * @deprecated 3.3 Use Function#bind. */ @@ -1414,7 +1412,7 @@ interface JQueryStatic { * * @param fn The function whose context will be changed. * @param context The object to which the context (this) of the function should be set. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.9 * @deprecated 3.3 Use Function#bind. */ @@ -1429,7 +1427,7 @@ interface JQueryStatic { * * @param fn The function whose context will be changed. * @param context The object to which the context (this) of the function should be set. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.9 * @deprecated 3.3 Use Function#bind. */ @@ -1446,7 +1444,7 @@ interface JQueryStatic { * * @param fn The function whose context will be changed. * @param context The object to which the context (this) of the function should be set. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.9 * @deprecated 3.3 Use Function#bind. */ @@ -1461,7 +1459,7 @@ interface JQueryStatic { * * @param fn The function whose context will be changed. * @param context The object to which the context (this) of the function should be set. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.9 * @deprecated 3.3 Use Function#bind. */ @@ -1476,7 +1474,7 @@ interface JQueryStatic { * * @param fn The function whose context will be changed. * @param context The object to which the context (this) of the function should be set. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.9 * @deprecated 3.3 Use Function#bind. */ @@ -1491,7 +1489,7 @@ interface JQueryStatic { * * @param fn The function whose context will be changed. * @param context The object to which the context (this) of the function should be set. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.9 * @deprecated 3.3 Use Function#bind. */ @@ -1506,7 +1504,7 @@ interface JQueryStatic { * * @param fn The function whose context will be changed. * @param context The object to which the context (this) of the function should be set. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.9 * @deprecated 3.3 Use Function#bind. */ @@ -1521,7 +1519,7 @@ interface JQueryStatic { * * @param fn The function whose context will be changed. * @param context The object to which the context (this) of the function should be set. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.9 * @deprecated 3.3 Use Function#bind. */ @@ -1536,7 +1534,7 @@ interface JQueryStatic { * * @param fn The function whose context will be changed. * @param context The object to which the context (this) of the function should be set. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.9 * @deprecated 3.3 Use Function#bind. */ @@ -1551,7 +1549,7 @@ interface JQueryStatic { * * @param fn The function whose context will be changed. * @param context The object to which the context (this) of the function should be set. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.9 * @deprecated 3.3 Use Function#bind. */ @@ -1568,7 +1566,7 @@ interface JQueryStatic { * * @param fn The function whose context will be changed. * @param context The object to which the context (this) of the function should be set. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.9 * @deprecated 3.3 Use Function#bind. */ @@ -1583,7 +1581,7 @@ interface JQueryStatic { * * @param fn The function whose context will be changed. * @param context The object to which the context (this) of the function should be set. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.9 * @deprecated 3.3 Use Function#bind. */ @@ -1598,7 +1596,7 @@ interface JQueryStatic { * * @param fn The function whose context will be changed. * @param context The object to which the context (this) of the function should be set. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.9 * @deprecated 3.3 Use Function#bind. */ @@ -1613,7 +1611,7 @@ interface JQueryStatic { * * @param fn The function whose context will be changed. * @param context The object to which the context (this) of the function should be set. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.9 * @deprecated 3.3 Use Function#bind. */ @@ -1628,7 +1626,7 @@ interface JQueryStatic { * * @param fn The function whose context will be changed. * @param context The object to which the context (this) of the function should be set. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.9 * @deprecated 3.3 Use Function#bind. */ @@ -1643,7 +1641,7 @@ interface JQueryStatic { * * @param fn The function whose context will be changed. * @param context The object to which the context (this) of the function should be set. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.9 * @deprecated 3.3 Use Function#bind. */ @@ -1658,7 +1656,7 @@ interface JQueryStatic { * * @param fn The function whose context will be changed. * @param context The object to which the context (this) of the function should be set. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.9 * @deprecated 3.3 Use Function#bind. */ @@ -1673,7 +1671,7 @@ interface JQueryStatic { * * @param fn The function whose context will be changed. * @param context The object to which the context (this) of the function should be set. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.9 * @deprecated 3.3 Use Function#bind. */ @@ -1690,7 +1688,7 @@ interface JQueryStatic { * * @param fn The function whose context will be changed. * @param context The object to which the context (this) of the function should be set. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.9 * @deprecated 3.3 Use Function#bind. */ @@ -1705,7 +1703,7 @@ interface JQueryStatic { * * @param fn The function whose context will be changed. * @param context The object to which the context (this) of the function should be set. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.9 * @deprecated 3.3 Use Function#bind. */ @@ -1720,7 +1718,7 @@ interface JQueryStatic { * * @param fn The function whose context will be changed. * @param context The object to which the context (this) of the function should be set. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.9 * @deprecated 3.3 Use Function#bind. */ @@ -1735,7 +1733,7 @@ interface JQueryStatic { * * @param fn The function whose context will be changed. * @param context The object to which the context (this) of the function should be set. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.9 * @deprecated 3.3 Use Function#bind. */ @@ -1750,7 +1748,7 @@ interface JQueryStatic { * * @param fn The function whose context will be changed. * @param context The object to which the context (this) of the function should be set. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.9 * @deprecated 3.3 Use Function#bind. */ @@ -1765,7 +1763,7 @@ interface JQueryStatic { * * @param fn The function whose context will be changed. * @param context The object to which the context (this) of the function should be set. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.9 * @deprecated 3.3 Use Function#bind. */ @@ -1780,7 +1778,7 @@ interface JQueryStatic { * * @param fn The function whose context will be changed. * @param context The object to which the context (this) of the function should be set. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.9 * @deprecated 3.3 Use Function#bind. */ @@ -1795,7 +1793,7 @@ interface JQueryStatic { * * @param fn The function whose context will be changed. * @param context The object to which the context (this) of the function should be set. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.9 * @deprecated 3.3 Use Function#bind. */ @@ -1815,7 +1813,7 @@ interface JQueryStatic { * @param fn The function whose context will be changed. * @param context The object to which the context (this) of the function should be set. * @param additionalArguments Any number of arguments to be passed to the function referenced in the function argument. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.9 * @deprecated 3.3 Use Function#bind. */ @@ -1838,7 +1836,7 @@ interface JQueryStatic { * * @param fn The function whose context will be changed. * @param context The object to which the context (this) of the function should be set. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4 * @since 1.6 * @deprecated 3.3 Use Function#bind. @@ -1853,7 +1851,7 @@ interface JQueryStatic { * * @param fn The function whose context will be changed. * @param context The object to which the context (this) of the function should be set. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4 * @since 1.6 * @deprecated 3.3 Use Function#bind. @@ -1868,7 +1866,7 @@ interface JQueryStatic { * * @param fn The function whose context will be changed. * @param context The object to which the context (this) of the function should be set. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4 * @since 1.6 * @deprecated 3.3 Use Function#bind. @@ -1883,7 +1881,7 @@ interface JQueryStatic { * * @param fn The function whose context will be changed. * @param context The object to which the context (this) of the function should be set. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4 * @since 1.6 * @deprecated 3.3 Use Function#bind. @@ -1898,7 +1896,7 @@ interface JQueryStatic { * * @param fn The function whose context will be changed. * @param context The object to which the context (this) of the function should be set. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4 * @since 1.6 * @deprecated 3.3 Use Function#bind. @@ -1913,7 +1911,7 @@ interface JQueryStatic { * * @param fn The function whose context will be changed. * @param context The object to which the context (this) of the function should be set. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4 * @since 1.6 * @deprecated 3.3 Use Function#bind. @@ -1928,7 +1926,7 @@ interface JQueryStatic { * * @param fn The function whose context will be changed. * @param context The object to which the context (this) of the function should be set. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4` * @since 1.6 * @deprecated 3.3 Use Function#bind. @@ -1943,7 +1941,7 @@ interface JQueryStatic { * * @param fn The function whose context will be changed. * @param context The object to which the context (this) of the function should be set. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4 * @since 1.6 * @deprecated 3.3 Use Function#bind. @@ -1961,7 +1959,7 @@ interface JQueryStatic { * * @param fn The function whose context will be changed. * @param context The object to which the context (this) of the function should be set. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4 * @since 1.6 * @deprecated 3.3 Use Function#bind. @@ -1978,7 +1976,7 @@ interface JQueryStatic { * * @param fn The function whose context will be changed. * @param context The object to which the context (this) of the function should be set. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4 * @since 1.6 * @deprecated 3.3 Use Function#bind. @@ -1995,7 +1993,7 @@ interface JQueryStatic { * * @param fn The function whose context will be changed. * @param context The object to which the context (this) of the function should be set. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4 * @since 1.6 * @deprecated 3.3 Use Function#bind. @@ -2012,7 +2010,7 @@ interface JQueryStatic { * * @param fn The function whose context will be changed. * @param context The object to which the context (this) of the function should be set. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4 * @since 1.6 * @deprecated 3.3 Use Function#bind. @@ -2029,7 +2027,7 @@ interface JQueryStatic { * * @param fn The function whose context will be changed. * @param context The object to which the context (this) of the function should be set. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4 * @since 1.6 * @deprecated 3.3 Use Function#bind. @@ -2046,7 +2044,7 @@ interface JQueryStatic { * * @param fn The function whose context will be changed. * @param context The object to which the context (this) of the function should be set. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4 * @since 1.6 * @deprecated 3.3 Use Function#bind. @@ -2063,7 +2061,7 @@ interface JQueryStatic { * * @param fn The function whose context will be changed. * @param context The object to which the context (this) of the function should be set. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4 * @since 1.6 * @deprecated 3.3 Use Function#bind. @@ -2080,7 +2078,7 @@ interface JQueryStatic { * * @param fn The function whose context will be changed. * @param context The object to which the context (this) of the function should be set. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4 * @since 1.6 * @deprecated 3.3 Use Function#bind. @@ -2099,7 +2097,7 @@ interface JQueryStatic { * * @param fn The function whose context will be changed. * @param context The object to which the context (this) of the function should be set. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4 * @since 1.6 * @deprecated 3.3 Use Function#bind. @@ -2116,7 +2114,7 @@ interface JQueryStatic { * * @param fn The function whose context will be changed. * @param context The object to which the context (this) of the function should be set. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4 * @since 1.6 * @deprecated 3.3 Use Function#bind. @@ -2133,7 +2131,7 @@ interface JQueryStatic { * * @param fn The function whose context will be changed. * @param context The object to which the context (this) of the function should be set. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4 * @since 1.6 * @deprecated 3.3 Use Function#bind. @@ -2150,7 +2148,7 @@ interface JQueryStatic { * * @param fn The function whose context will be changed. * @param context The object to which the context (this) of the function should be set. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4 * @since 1.6 * @deprecated 3.3 Use Function#bind. @@ -2167,7 +2165,7 @@ interface JQueryStatic { * * @param fn The function whose context will be changed. * @param context The object to which the context (this) of the function should be set. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4 * @since 1.6 * @deprecated 3.3 Use Function#bind. @@ -2184,7 +2182,7 @@ interface JQueryStatic { * * @param fn The function whose context will be changed. * @param context The object to which the context (this) of the function should be set. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4 * @since 1.6 * @deprecated 3.3 Use Function#bind. @@ -2201,7 +2199,7 @@ interface JQueryStatic { * * @param fn The function whose context will be changed. * @param context The object to which the context (this) of the function should be set. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4 * @since 1.6 * @deprecated 3.3 Use Function#bind. @@ -2218,7 +2216,7 @@ interface JQueryStatic { * * @param fn The function whose context will be changed. * @param context The object to which the context (this) of the function should be set. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4 * @since 1.6 * @deprecated 3.3 Use Function#bind. @@ -2237,7 +2235,7 @@ interface JQueryStatic { * * @param fn The function whose context will be changed. * @param context The object to which the context (this) of the function should be set. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4 * @since 1.6 * @deprecated 3.3 Use Function#bind. @@ -2254,7 +2252,7 @@ interface JQueryStatic { * * @param fn The function whose context will be changed. * @param context The object to which the context (this) of the function should be set. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4 * @since 1.6 * @deprecated 3.3 Use Function#bind. @@ -2271,7 +2269,7 @@ interface JQueryStatic { * * @param fn The function whose context will be changed. * @param context The object to which the context (this) of the function should be set. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4 * @since 1.6 * @deprecated 3.3 Use Function#bind. @@ -2288,7 +2286,7 @@ interface JQueryStatic { * * @param fn The function whose context will be changed. * @param context The object to which the context (this) of the function should be set. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4 * @since 1.6 * @deprecated 3.3 Use Function#bind. @@ -2305,7 +2303,7 @@ interface JQueryStatic { * * @param fn The function whose context will be changed. * @param context The object to which the context (this) of the function should be set. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4 * @since 1.6 * @deprecated 3.3 Use Function#bind. @@ -2322,7 +2320,7 @@ interface JQueryStatic { * * @param fn The function whose context will be changed. * @param context The object to which the context (this) of the function should be set. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4 * @since 1.6 * @deprecated 3.3 Use Function#bind. @@ -2339,7 +2337,7 @@ interface JQueryStatic { * * @param fn The function whose context will be changed. * @param context The object to which the context (this) of the function should be set. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4 * @since 1.6 * @deprecated 3.3 Use Function#bind. @@ -2356,7 +2354,7 @@ interface JQueryStatic { * * @param fn The function whose context will be changed. * @param context The object to which the context (this) of the function should be set. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4 * @since 1.6 * @deprecated 3.3 Use Function#bind. @@ -2375,7 +2373,7 @@ interface JQueryStatic { * * @param fn The function whose context will be changed. * @param context The object to which the context (this) of the function should be set. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4 * @since 1.6 * @deprecated 3.3 Use Function#bind. @@ -2392,7 +2390,7 @@ interface JQueryStatic { * * @param fn The function whose context will be changed. * @param context The object to which the context (this) of the function should be set. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4 * @since 1.6 * @deprecated 3.3 Use Function#bind. @@ -2409,7 +2407,7 @@ interface JQueryStatic { * * @param fn The function whose context will be changed. * @param context The object to which the context (this) of the function should be set. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4 * @since 1.6 * @deprecated 3.3 Use Function#bind. @@ -2426,7 +2424,7 @@ interface JQueryStatic { * * @param fn The function whose context will be changed. * @param context The object to which the context (this) of the function should be set. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4 * @since 1.6 * @deprecated 3.3 Use Function#bind. @@ -2443,7 +2441,7 @@ interface JQueryStatic { * * @param fn The function whose context will be changed. * @param context The object to which the context (this) of the function should be set. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4 * @since 1.6 * @deprecated 3.3 Use Function#bind. @@ -2460,7 +2458,7 @@ interface JQueryStatic { * * @param fn The function whose context will be changed. * @param context The object to which the context (this) of the function should be set. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4 * @since 1.6 * @deprecated 3.3 Use Function#bind. @@ -2477,7 +2475,7 @@ interface JQueryStatic { * * @param fn The function whose context will be changed. * @param context The object to which the context (this) of the function should be set. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4 * @since 1.6 * @deprecated 3.3 Use Function#bind. @@ -2494,7 +2492,7 @@ interface JQueryStatic { * * @param fn The function whose context will be changed. * @param context The object to which the context (this) of the function should be set. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4 * @since 1.6 * @deprecated 3.3 Use Function#bind. @@ -2513,7 +2511,7 @@ interface JQueryStatic { * * @param fn The function whose context will be changed. * @param context The object to which the context (this) of the function should be set. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4 * @since 1.6 * @deprecated 3.3 Use Function#bind. @@ -2530,7 +2528,7 @@ interface JQueryStatic { * * @param fn The function whose context will be changed. * @param context The object to which the context (this) of the function should be set. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4 * @since 1.6 * @deprecated 3.3 Use Function#bind. @@ -2547,7 +2545,7 @@ interface JQueryStatic { * * @param fn The function whose context will be changed. * @param context The object to which the context (this) of the function should be set. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4 * @since 1.6 * @deprecated 3.3 Use Function#bind. @@ -2564,7 +2562,7 @@ interface JQueryStatic { * * @param fn The function whose context will be changed. * @param context The object to which the context (this) of the function should be set. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4 * @since 1.6 * @deprecated 3.3 Use Function#bind. @@ -2581,7 +2579,7 @@ interface JQueryStatic { * * @param fn The function whose context will be changed. * @param context The object to which the context (this) of the function should be set. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4 * @since 1.6 * @deprecated 3.3 Use Function#bind. @@ -2598,7 +2596,7 @@ interface JQueryStatic { * * @param fn The function whose context will be changed. * @param context The object to which the context (this) of the function should be set. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4 * @since 1.6 * @deprecated 3.3 Use Function#bind. @@ -2615,7 +2613,7 @@ interface JQueryStatic { * * @param fn The function whose context will be changed. * @param context The object to which the context (this) of the function should be set. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4 * @since 1.6 * @deprecated 3.3 Use Function#bind. @@ -2632,7 +2630,7 @@ interface JQueryStatic { * * @param fn The function whose context will be changed. * @param context The object to which the context (this) of the function should be set. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4 * @since 1.6 * @deprecated 3.3 Use Function#bind. @@ -2651,7 +2649,7 @@ interface JQueryStatic { * * @param fn The function whose context will be changed. * @param context The object to which the context (this) of the function should be set. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4 * @since 1.6 * @deprecated 3.3 Use Function#bind. @@ -2668,7 +2666,7 @@ interface JQueryStatic { * * @param fn The function whose context will be changed. * @param context The object to which the context (this) of the function should be set. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4 * @since 1.6 * @deprecated 3.3 Use Function#bind. @@ -2685,7 +2683,7 @@ interface JQueryStatic { * * @param fn The function whose context will be changed. * @param context The object to which the context (this) of the function should be set. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4 * @since 1.6 * @deprecated 3.3 Use Function#bind. @@ -2702,7 +2700,7 @@ interface JQueryStatic { * * @param fn The function whose context will be changed. * @param context The object to which the context (this) of the function should be set. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4 * @since 1.6 * @deprecated 3.3 Use Function#bind. @@ -2719,7 +2717,7 @@ interface JQueryStatic { * * @param fn The function whose context will be changed. * @param context The object to which the context (this) of the function should be set. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4 * @since 1.6 * @deprecated 3.3 Use Function#bind. @@ -2736,7 +2734,7 @@ interface JQueryStatic { * * @param fn The function whose context will be changed. * @param context The object to which the context (this) of the function should be set. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4 * @since 1.6 * @deprecated 3.3 Use Function#bind. @@ -2753,7 +2751,7 @@ interface JQueryStatic { * * @param fn The function whose context will be changed. * @param context The object to which the context (this) of the function should be set. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4 * @since 1.6 * @deprecated 3.3 Use Function#bind. @@ -2770,7 +2768,7 @@ interface JQueryStatic { * * @param fn The function whose context will be changed. * @param context The object to which the context (this) of the function should be set. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4 * @since 1.6 * @deprecated 3.3 Use Function#bind. @@ -2789,7 +2787,7 @@ interface JQueryStatic { * * @param fn The function whose context will be changed. * @param context The object to which the context (this) of the function should be set. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4 * @since 1.6 * @deprecated 3.3 Use Function#bind. @@ -2806,7 +2804,7 @@ interface JQueryStatic { * * @param fn The function whose context will be changed. * @param context The object to which the context (this) of the function should be set. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4 * @since 1.6 * @deprecated 3.3 Use Function#bind. @@ -2823,7 +2821,7 @@ interface JQueryStatic { * * @param fn The function whose context will be changed. * @param context The object to which the context (this) of the function should be set. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4 * @since 1.6 * @deprecated 3.3 Use Function#bind. @@ -2840,7 +2838,7 @@ interface JQueryStatic { * * @param fn The function whose context will be changed. * @param context The object to which the context (this) of the function should be set. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4 * @since 1.6 * @deprecated 3.3 Use Function#bind. @@ -2857,7 +2855,7 @@ interface JQueryStatic { * * @param fn The function whose context will be changed. * @param context The object to which the context (this) of the function should be set. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4 * @since 1.6 * @deprecated 3.3 Use Function#bind. @@ -2874,7 +2872,7 @@ interface JQueryStatic { * * @param fn The function whose context will be changed. * @param context The object to which the context (this) of the function should be set. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4 * @since 1.6 * @deprecated 3.3 Use Function#bind. @@ -2891,7 +2889,7 @@ interface JQueryStatic { * * @param fn The function whose context will be changed. * @param context The object to which the context (this) of the function should be set. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4 * @since 1.6 * @deprecated 3.3 Use Function#bind. @@ -2908,7 +2906,7 @@ interface JQueryStatic { * * @param fn The function whose context will be changed. * @param context The object to which the context (this) of the function should be set. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4 * @since 1.6 * @deprecated 3.3 Use Function#bind. @@ -2930,7 +2928,7 @@ interface JQueryStatic { * @param fn The function whose context will be changed. * @param context The object to which the context (this) of the function should be set. * @param additionalArguments Any number of arguments to be passed to the function referenced in the function argument. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4 * @since 1.6 * @deprecated 3.3 Use Function#bind. @@ -2952,7 +2950,7 @@ interface JQueryStatic { * @param context The object to which the context of the function should be set. * @param name The name of the function whose context will be changed (should be a property of the context object). * @param additionalArguments Any number of arguments to be passed to the function named in the name argument. - * @see {@link https://api.jquery.com/jQuery.proxy/} + * @see \`{@link https://api.jquery.com/jQuery.proxy/ }\` * @since 1.4 * @since 1.6 * @deprecated 3.3 Use Function#bind. @@ -2972,7 +2970,7 @@ interface JQueryStatic { * @param queueName A string containing the name of the queue. Defaults to fx, the standard effects queue. * @param newQueue The new function to add to the queue. * An array of functions to replace the current queue contents. - * @see {@link https://api.jquery.com/jQuery.queue/} + * @see \`{@link https://api.jquery.com/jQuery.queue/ }\` * @since 1.3 */ queue(element: T, queueName?: string, newQueue?: JQuery.TypeOrArray>): JQuery.Queue; @@ -2980,7 +2978,7 @@ interface JQueryStatic { * Handles errors thrown synchronously in functions wrapped in jQuery(). * * @param error An error thrown in the function wrapped in jQuery(). - * @see {@link https://api.jquery.com/jQuery.readyException/} + * @see \`{@link https://api.jquery.com/jQuery.readyException/ }\` * @since 3.1 */ readyException(error: Error): any; @@ -2989,7 +2987,7 @@ interface JQueryStatic { * * @param element A DOM element from which to remove data. * @param name A string naming the piece of data to remove. - * @see {@link https://api.jquery.com/jQuery.removeData/} + * @see \`{@link https://api.jquery.com/jQuery.removeData/ }\` * @since 1.2.3 */ removeData(element: Element, name?: string): void; @@ -2999,7 +2997,7 @@ interface JQueryStatic { * @param duration A string or number determining how long the animation will run. * @param easing A string indicating which easing function to use for the transition. * @param complete A function to call once the animation is complete, called once per matched element. - * @see {@link https://api.jquery.com/jQuery.speed/} + * @see \`{@link https://api.jquery.com/jQuery.speed/ }\` * @since 1.1 */ speed(duration: JQuery.Duration, easing: string, complete: (this: TElement) => void): JQuery.EffectsOptions; @@ -3009,7 +3007,7 @@ interface JQueryStatic { * @param duration A string or number determining how long the animation will run. * @param easing_complete A string indicating which easing function to use for the transition. * A function to call once the animation is complete, called once per matched element. - * @see {@link https://api.jquery.com/jQuery.speed/} + * @see \`{@link https://api.jquery.com/jQuery.speed/ }\` * @since 1.0 * @since 1.1 */ @@ -3020,7 +3018,7 @@ interface JQueryStatic { * * @param duration_complete_settings A string or number determining how long the animation will run. * A function to call once the animation is complete, called once per matched element. - * @see {@link https://api.jquery.com/jQuery.speed/} + * @see \`{@link https://api.jquery.com/jQuery.speed/ }\` * @since 1.0 * @since 1.1 */ @@ -3029,7 +3027,7 @@ interface JQueryStatic { * Remove the whitespace from the beginning and end of a string. * * @param str The string to trim. - * @see {@link https://api.jquery.com/jQuery.trim/} + * @see \`{@link https://api.jquery.com/jQuery.trim/ }\` * @since 1.0 */ trim(str: string): string; @@ -3037,7 +3035,7 @@ interface JQueryStatic { * Determine the internal JavaScript [[Class]] of an object. * * @param obj Object to get the internal JavaScript [[Class]] of. - * @see {@link https://api.jquery.com/jQuery.type/} + * @see \`{@link https://api.jquery.com/jQuery.type/ }\` * @since 1.4.3 * @deprecated 3.3 */ @@ -3047,7 +3045,7 @@ interface JQueryStatic { * arrays of DOM elements, not strings or numbers. * * @param array The Array of DOM elements. - * @see {@link https://api.jquery.com/jQuery.unique/} + * @see \`{@link https://api.jquery.com/jQuery.unique/ }\` * @since 1.1.3 * @deprecated 3.0 */ @@ -3057,7 +3055,7 @@ interface JQueryStatic { * arrays of DOM elements, not strings or numbers. * * @param array The Array of DOM elements. - * @see {@link https://api.jquery.com/jQuery.uniqueSort/} + * @see \`{@link https://api.jquery.com/jQuery.uniqueSort/ }\` * @since 1.12 * @since 2.2 */ @@ -3066,7 +3064,7 @@ interface JQueryStatic { * Provides a way to execute callback functions based on zero or more Thenable objects, usually * Deferred objects that represent asynchronous events. * - * @see {@link https://api.jquery.com/jQuery.when/} + * @see \`{@link https://api.jquery.com/jQuery.when/ }\` * @since 1.5 */ when { * Provides a way to execute callback functions based on zero or more Thenable objects, usually * Deferred objects that represent asynchronous events. * - * @see {@link https://api.jquery.com/jQuery.when/} + * @see \`{@link https://api.jquery.com/jQuery.when/ }\` * @since 1.5 */ when { * Provides a way to execute callback functions based on zero or more Thenable objects, usually * Deferred objects that represent asynchronous events. * - * @see {@link https://api.jquery.com/jQuery.when/} + * @see \`{@link https://api.jquery.com/jQuery.when/ }\` * @since 1.5 */ when { * Provides a way to execute callback functions based on zero or more Thenable objects, usually * Deferred objects that represent asynchronous events. * - * @see {@link https://api.jquery.com/jQuery.when/} + * @see \`{@link https://api.jquery.com/jQuery.when/ }\` * @since 1.5 */ when(deferred: JQuery.Promise | JQuery.Thenable | TR1): JQuery.Promise; @@ -3113,7 +3111,7 @@ interface JQueryStatic { * Deferred objects that represent asynchronous events. * * @param deferreds Zero or more Thenable objects. - * @see {@link https://api.jquery.com/jQuery.when/} + * @see \`{@link https://api.jquery.com/jQuery.when/ }\` * @since 1.5 */ when(...deferreds: Array | JQuery.Thenable | TR1>): JQuery.Promise; @@ -3122,7 +3120,7 @@ interface JQueryStatic { * Deferred objects that represent asynchronous events. * * @param deferreds Zero or more Thenable objects. - * @see {@link https://api.jquery.com/jQuery.when/} + * @see \`{@link https://api.jquery.com/jQuery.when/ }\` * @since 1.5 */ when(...deferreds: any[]): JQuery.Promise; @@ -3132,14 +3130,14 @@ interface JQuery extends Iterable { /** * A string containing the jQuery version number. * - * @see {@link https://api.jquery.com/jquery/} + * @see \`{@link https://api.jquery.com/jquery/ }\` * @since 1.0 */ jquery: string; /** * The number of elements in the jQuery object. * - * @see {@link https://api.jquery.com/length/} + * @see \`{@link https://api.jquery.com/length/ }\` * @since 1.0 */ length: number; @@ -3149,7 +3147,7 @@ interface JQuery extends Iterable { * @param selector A string representing a selector expression to find additional elements to add to the set of matched elements. * @param context The point in the document at which the selector should begin matching; similar to the context * argument of the $(selector, context) method. - * @see {@link https://api.jquery.com/add/} + * @see \`{@link https://api.jquery.com/add/ }\` * @since 1.4 */ add(selector: JQuery.Selector, context: Element): this; @@ -3160,7 +3158,7 @@ interface JQuery extends Iterable { * One or more elements to add to the set of matched elements. * An HTML fragment to add to the set of matched elements. * An existing jQuery object to add to the set of matched elements. - * @see {@link https://api.jquery.com/add/} + * @see \`{@link https://api.jquery.com/add/ }\` * @since 1.0 * @since 1.3.2 */ @@ -3169,7 +3167,7 @@ interface JQuery extends Iterable { * Add the previous set of elements on the stack to the current set, optionally filtered by a selector. * * @param selector A string containing a selector expression to match the current set of elements against. - * @see {@link https://api.jquery.com/addBack/} + * @see \`{@link https://api.jquery.com/addBack/ }\` * @since 1.8 */ addBack(selector?: JQuery.Selector): this; @@ -3181,7 +3179,7 @@ interface JQuery extends Iterable { * A function returning one or more space-separated class names to be added to the existing class * name(s). Receives the index position of the element in the set and the existing class name(s) as * arguments. Within the function, this refers to the current element in the set. - * @see {@link https://api.jquery.com/addClass/} + * @see \`{@link https://api.jquery.com/addClass/ }\` * @since 1.0 * @since 1.4 * @since 3.3 @@ -3192,7 +3190,7 @@ interface JQuery extends Iterable { * * @param contents One or more additional DOM elements, text nodes, arrays of elements and text nodes, HTML strings, or * jQuery objects to insert after each element in the set of matched elements. - * @see {@link https://api.jquery.com/after/} + * @see \`{@link https://api.jquery.com/after/ }\` * @since 1.0 */ after(...contents: Array>>): this; @@ -3203,7 +3201,7 @@ interface JQuery extends Iterable { * after each element in the set of matched elements. Receives the index position of the element in the * set and the old HTML value of the element as arguments. Within the function, this refers to the * current element in the set. - * @see {@link https://api.jquery.com/after/} + * @see \`{@link https://api.jquery.com/after/ }\` * @since 1.4 * @since 1.10 */ @@ -3212,7 +3210,7 @@ interface JQuery extends Iterable { * Register a handler to be called when Ajax requests complete. This is an AjaxEvent. * * @param handler The function to be invoked. - * @see {@link https://api.jquery.com/ajaxComplete/} + * @see \`{@link https://api.jquery.com/ajaxComplete/ }\` * @since 1.0 */ ajaxComplete(handler: (this: Document, event: JQuery.Event, jqXHR: JQuery.jqXHR, ajaxOptions: JQuery.AjaxSettings) => void | false): this; @@ -3220,7 +3218,7 @@ interface JQuery extends Iterable { * Register a handler to be called when Ajax requests complete with an error. This is an Ajax Event. * * @param handler The function to be invoked. - * @see {@link https://api.jquery.com/ajaxError/} + * @see \`{@link https://api.jquery.com/ajaxError/ }\` * @since 1.0 */ ajaxError(handler: (this: Document, event: JQuery.Event, jqXHR: JQuery.jqXHR, ajaxSettings: JQuery.AjaxSettings, thrownError: string) => void | false): this; @@ -3228,7 +3226,7 @@ interface JQuery extends Iterable { * Attach a function to be executed before an Ajax request is sent. This is an Ajax Event. * * @param handler The function to be invoked. - * @see {@link https://api.jquery.com/ajaxSend/} + * @see \`{@link https://api.jquery.com/ajaxSend/ }\` * @since 1.0 */ ajaxSend(handler: (this: Document, event: JQuery.Event, jqXHR: JQuery.jqXHR, ajaxOptions: JQuery.AjaxSettings) => void | false): this; @@ -3236,7 +3234,7 @@ interface JQuery extends Iterable { * Register a handler to be called when the first Ajax request begins. This is an Ajax Event. * * @param handler The function to be invoked. - * @see {@link https://api.jquery.com/ajaxStart/} + * @see \`{@link https://api.jquery.com/ajaxStart/ }\` * @since 1.0 */ ajaxStart(handler: (this: Document) => void | false): this; @@ -3244,7 +3242,7 @@ interface JQuery extends Iterable { * Register a handler to be called when all Ajax requests have completed. This is an Ajax Event. * * @param handler The function to be invoked. - * @see {@link https://api.jquery.com/ajaxStop/} + * @see \`{@link https://api.jquery.com/ajaxStop/ }\` * @since 1.0 */ ajaxStop(handler: (this: Document) => void | false): this; @@ -3252,7 +3250,7 @@ interface JQuery extends Iterable { * Attach a function to be executed whenever an Ajax request completes successfully. This is an Ajax Event. * * @param handler The function to be invoked. - * @see {@link https://api.jquery.com/ajaxSuccess/} + * @see \`{@link https://api.jquery.com/ajaxSuccess/ }\` * @since 1.0 */ ajaxSuccess(handler: (this: Document, event: JQuery.Event, jqXHR: JQuery.jqXHR, ajaxOptions: JQuery.AjaxSettings, data: JQuery.PlainObject) => void | false): this; @@ -3263,7 +3261,7 @@ interface JQuery extends Iterable { * @param duration A string or number determining how long the animation will run. * @param easing A string indicating which easing function to use for the transition. * @param complete A function to call once the animation is complete, called once per matched element. - * @see {@link https://api.jquery.com/animate/} + * @see \`{@link https://api.jquery.com/animate/ }\` * @since 1.0 */ animate(properties: JQuery.PlainObject, @@ -3277,7 +3275,7 @@ interface JQuery extends Iterable { * @param duration_easing A string or number determining how long the animation will run. * A string indicating which easing function to use for the transition. * @param complete A function to call once the animation is complete, called once per matched element. - * @see {@link https://api.jquery.com/animate/} + * @see \`{@link https://api.jquery.com/animate/ }\` * @since 1.0 */ animate(properties: JQuery.PlainObject, @@ -3288,7 +3286,7 @@ interface JQuery extends Iterable { * * @param properties An object of CSS properties and values that the animation will move toward. * @param options A map of additional options to pass to the method. - * @see {@link https://api.jquery.com/animate/} + * @see \`{@link https://api.jquery.com/animate/ }\` * @since 1.0 */ animate(properties: JQuery.PlainObject, @@ -3298,7 +3296,7 @@ interface JQuery extends Iterable { * * @param properties An object of CSS properties and values that the animation will move toward. * @param complete A function to call once the animation is complete, called once per matched element. - * @see {@link https://api.jquery.com/animate/} + * @see \`{@link https://api.jquery.com/animate/ }\` * @since 1.0 */ animate(properties: JQuery.PlainObject, @@ -3308,7 +3306,7 @@ interface JQuery extends Iterable { * * @param contents One or more additional DOM elements, text nodes, arrays of elements and text nodes, HTML strings, or * jQuery objects to insert at the end of each element in the set of matched elements. - * @see {@link https://api.jquery.com/append/} + * @see \`{@link https://api.jquery.com/append/ }\` * @since 1.0 */ append(...contents: Array>>): this; @@ -3319,7 +3317,7 @@ interface JQuery extends Iterable { * the end of each element in the set of matched elements. Receives the index position of the element * in the set and the old HTML value of the element as arguments. Within the function, this refers to * the current element in the set. - * @see {@link https://api.jquery.com/append/} + * @see \`{@link https://api.jquery.com/append/ }\` * @since 1.4 */ append(fn: (this: TElement, index: number, html: string) => JQuery.htmlString | JQuery.TypeOrArray>): this; @@ -3328,7 +3326,7 @@ interface JQuery extends Iterable { * * @param target A selector, element, HTML string, array of elements, or jQuery object; the matched set of elements * will be inserted at the end of the element(s) specified by this parameter. - * @see {@link https://api.jquery.com/appendTo/} + * @see \`{@link https://api.jquery.com/appendTo/ }\` * @since 1.0 */ appendTo(target: JQuery.Selector | JQuery.htmlString | JQuery.TypeOrArray | JQuery): this; @@ -3339,7 +3337,7 @@ interface JQuery extends Iterable { * @param value A value to set for the attribute. If null, the specified attribute will be removed (as in .removeAttr()). * A function returning the value to set. this is the current element. Receives the index position of * the element in the set and the old attribute value as arguments. - * @see {@link https://api.jquery.com/attr/} + * @see \`{@link https://api.jquery.com/attr/ }\` * @since 1.0 * @since 1.1 */ @@ -3349,7 +3347,7 @@ interface JQuery extends Iterable { * Set one or more attributes for the set of matched elements. * * @param attributes An object of attribute-value pairs to set. - * @see {@link https://api.jquery.com/attr/} + * @see \`{@link https://api.jquery.com/attr/ }\` * @since 1.0 */ attr(attributes: JQuery.PlainObject): this; @@ -3357,7 +3355,7 @@ interface JQuery extends Iterable { * Get the value of an attribute for the first element in the set of matched elements. * * @param attributeName The name of the attribute to get. - * @see {@link https://api.jquery.com/attr/} + * @see \`{@link https://api.jquery.com/attr/ }\` * @since 1.0 */ attr(attributeName: string): string | undefined; @@ -3366,7 +3364,7 @@ interface JQuery extends Iterable { * * @param contents One or more additional DOM elements, text nodes, arrays of elements and text nodes, HTML strings, or * jQuery objects to insert before each element in the set of matched elements. - * @see {@link https://api.jquery.com/before/} + * @see \`{@link https://api.jquery.com/before/ }\` * @since 1.0 */ before(...contents: Array>>): this; @@ -3377,7 +3375,7 @@ interface JQuery extends Iterable { * before each element in the set of matched elements. Receives the index position of the element in * the set and the old HTML value of the element as arguments. Within the function, this refers to the * current element in the set. - * @see {@link https://api.jquery.com/before/} + * @see \`{@link https://api.jquery.com/before/ }\` * @since 1.4 * @since 1.10 */ @@ -3389,7 +3387,7 @@ interface JQuery extends Iterable { * @param eventType A string containing one or more DOM event types, such as "click" or "submit," or custom event names. * @param eventData An object containing data that will be passed to the event handler. * @param handler A function to execute each time the event is triggered. - * @see {@link https://api.jquery.com/bind/} + * @see \`{@link https://api.jquery.com/bind/ }\` * @since 1.0 * @since 1.4.3 * @deprecated 3.0 @@ -3404,7 +3402,7 @@ interface JQuery extends Iterable { * @param handler A function to execute each time the event is triggered. * Setting the second argument to false will attach a function that prevents the default action from * occurring and stops the event from bubbling. - * @see {@link https://api.jquery.com/bind/} + * @see \`{@link https://api.jquery.com/bind/ }\` * @since 1.0 * @since 1.4.3 * @deprecated 3.0 @@ -3415,7 +3413,7 @@ interface JQuery extends Iterable { * Attach a handler to an event for the elements. * * @param events An object containing one or more DOM event types and functions to execute for them. - * @see {@link https://api.jquery.com/bind/} + * @see \`{@link https://api.jquery.com/bind/ }\` * @since 1.4 * @deprecated 3.0 */ @@ -3425,7 +3423,7 @@ interface JQuery extends Iterable { * * @param eventData An object containing data that will be passed to the event handler. * @param handler A function to execute each time the event is triggered. - * @see {@link https://api.jquery.com/blur/} + * @see \`{@link https://api.jquery.com/blur/ }\` * @since 1.4.3 * @deprecated 3.3 */ @@ -3435,7 +3433,7 @@ interface JQuery extends Iterable { * Bind an event handler to the "blur" JavaScript event, or trigger that event on an element. * * @param handler A function to execute each time the event is triggered. - * @see {@link https://api.jquery.com/blur/} + * @see \`{@link https://api.jquery.com/blur/ }\` * @since 1.0 * @deprecated 3.3 */ @@ -3445,7 +3443,7 @@ interface JQuery extends Iterable { * * @param eventData An object containing data that will be passed to the event handler. * @param handler A function to execute each time the event is triggered. - * @see {@link https://api.jquery.com/change/} + * @see \`{@link https://api.jquery.com/change/ }\` * @since 1.4.3 * @deprecated 3.3 */ @@ -3455,7 +3453,7 @@ interface JQuery extends Iterable { * Bind an event handler to the "change" JavaScript event, or trigger that event on an element. * * @param handler A function to execute each time the event is triggered. - * @see {@link https://api.jquery.com/change/} + * @see \`{@link https://api.jquery.com/change/ }\` * @since 1.0 * @deprecated 3.3 */ @@ -3464,7 +3462,7 @@ interface JQuery extends Iterable { * Get the children of each element in the set of matched elements, optionally filtered by a selector. * * @param selector A string containing a selector expression to match elements against. - * @see {@link https://api.jquery.com/children/} + * @see \`{@link https://api.jquery.com/children/ }\` * @since 1.0 */ children(selector?: JQuery.Selector): this; @@ -3472,7 +3470,7 @@ interface JQuery extends Iterable { * Remove from the queue all items that have not yet been run. * * @param queueName A string containing the name of the queue. Defaults to fx, the standard effects queue. - * @see {@link https://api.jquery.com/clearQueue/} + * @see \`{@link https://api.jquery.com/clearQueue/ }\` * @since 1.4 */ clearQueue(queueName?: string): this; @@ -3481,7 +3479,7 @@ interface JQuery extends Iterable { * * @param eventData An object containing data that will be passed to the event handler. * @param handler A function to execute each time the event is triggered. - * @see {@link https://api.jquery.com/click/} + * @see \`{@link https://api.jquery.com/click/ }\` * @since 1.4.3 * @deprecated 3.3 */ @@ -3491,7 +3489,7 @@ interface JQuery extends Iterable { * Bind an event handler to the "click" JavaScript event, or trigger that event on an element. * * @param handler A function to execute each time the event is triggered. - * @see {@link https://api.jquery.com/click/} + * @see \`{@link https://api.jquery.com/click/ }\` * @since 1.0 * @deprecated 3.3 */ @@ -3504,7 +3502,7 @@ interface JQuery extends Iterable { * to false in 1.5.1 and up. * @param deepWithDataAndEvents A Boolean indicating whether event handlers and data for all children of the cloned element should * be copied. By default its value matches the first argument's value (which defaults to false). - * @see {@link https://api.jquery.com/clone/} + * @see \`{@link https://api.jquery.com/clone/ }\` * @since 1.0 * @since 1.5 */ @@ -3515,7 +3513,7 @@ interface JQuery extends Iterable { * * @param selector A string containing a selector expression to match elements against. * @param context A DOM element within which a matching element may be found. - * @see {@link https://api.jquery.com/closest/} + * @see \`{@link https://api.jquery.com/closest/ }\` * @since 1.4 */ closest(selector: JQuery.Selector, context: Element): this; @@ -3526,7 +3524,7 @@ interface JQuery extends Iterable { * @param selector A string containing a selector expression to match elements against. * A jQuery object to match elements against. * An element to match elements against. - * @see {@link https://api.jquery.com/closest/} + * @see \`{@link https://api.jquery.com/closest/ }\` * @since 1.3 * @since 1.6 */ @@ -3534,7 +3532,7 @@ interface JQuery extends Iterable { /** * Get the children of each element in the set of matched elements, including text and comment nodes. * - * @see {@link https://api.jquery.com/contents/} + * @see \`{@link https://api.jquery.com/contents/ }\` * @since 1.2 */ contents(): JQuery; @@ -3543,7 +3541,7 @@ interface JQuery extends Iterable { * * @param eventData An object containing data that will be passed to the event handler. * @param handler A function to execute each time the event is triggered. - * @see {@link https://api.jquery.com/contextmenu/} + * @see \`{@link https://api.jquery.com/contextmenu/ }\` * @since 1.4.3 * @deprecated 3.3 */ @@ -3553,7 +3551,7 @@ interface JQuery extends Iterable { * Bind an event handler to the "contextmenu" JavaScript event, or trigger that event on an element. * * @param handler A function to execute each time the event is triggered. - * @see {@link https://api.jquery.com/contextmenu/} + * @see \`{@link https://api.jquery.com/contextmenu/ }\` * @since 1.0 * @deprecated 3.3 */ @@ -3565,7 +3563,7 @@ interface JQuery extends Iterable { * @param value A value to set for the property. * A function returning the value to set. this is the current element. Receives the index position of * the element in the set and the old value as arguments. - * @see {@link https://api.jquery.com/css/} + * @see \`{@link https://api.jquery.com/css/ }\` * @since 1.0 * @since 1.4 */ @@ -3575,7 +3573,7 @@ interface JQuery extends Iterable { * Set one or more CSS properties for the set of matched elements. * * @param properties An object of property-value pairs to set. - * @see {@link https://api.jquery.com/css/} + * @see \`{@link https://api.jquery.com/css/ }\` * @since 1.0 */ css(properties: JQuery.PlainObject string | number | void | undefined)>): this; @@ -3584,7 +3582,7 @@ interface JQuery extends Iterable { * * @param propertyName A CSS property. * An array of one or more CSS properties. - * @see {@link https://api.jquery.com/css/} + * @see \`{@link https://api.jquery.com/css/ }\` * @since 1.0 */ css(propertyName: string): string; @@ -3592,7 +3590,7 @@ interface JQuery extends Iterable { * Get the computed style properties for the first element in the set of matched elements. * * @param propertyNames An array of one or more CSS properties. - * @see {@link https://api.jquery.com/css/} + * @see \`{@link https://api.jquery.com/css/ }\` * @since 1.9 */ css(propertyNames: string[]): JQuery.PlainObject; @@ -3601,7 +3599,7 @@ interface JQuery extends Iterable { * data(name, value) or by an HTML5 data-* attribute. * * @param key Name of the data stored. - * @see {@link https://api.jquery.com/data/} + * @see \`{@link https://api.jquery.com/data/ }\` * @since 1.2.3 */ data(key: string, undefined: undefined): any; // tslint:disable-line:unified-signatures @@ -3610,7 +3608,7 @@ interface JQuery extends Iterable { * * @param key A string naming the piece of data to set. * @param value The new data value; this can be any Javascript type except undefined. - * @see {@link https://api.jquery.com/data/} + * @see \`{@link https://api.jquery.com/data/ }\` * @since 1.2.3 */ data(key: string, value: any): this; @@ -3618,7 +3616,7 @@ interface JQuery extends Iterable { * Store arbitrary data associated with the matched elements. * * @param obj An object of key-value pairs of data to update. - * @see {@link https://api.jquery.com/data/} + * @see \`{@link https://api.jquery.com/data/ }\` * @since 1.4.3 */ data(obj: JQuery.PlainObject): this; @@ -3627,7 +3625,7 @@ interface JQuery extends Iterable { * data(name, value) or by an HTML5 data-* attribute. * * @param key Name of the data stored. - * @see {@link https://api.jquery.com/data/} + * @see \`{@link https://api.jquery.com/data/ }\` * @since 1.2.3 */ data(key: string): any; @@ -3635,7 +3633,7 @@ interface JQuery extends Iterable { * Return the value at the named data store for the first element in the jQuery collection, as set by * data(name, value) or by an HTML5 data-* attribute. * - * @see {@link https://api.jquery.com/data/} + * @see \`{@link https://api.jquery.com/data/ }\` * @since 1.4 */ data(): JQuery.PlainObject; @@ -3644,7 +3642,7 @@ interface JQuery extends Iterable { * * @param eventData An object containing data that will be passed to the event handler. * @param handler A function to execute each time the event is triggered. - * @see {@link https://api.jquery.com/dblclick/} + * @see \`{@link https://api.jquery.com/dblclick/ }\` * @since 1.4.3 * @deprecated 3.3 */ @@ -3654,7 +3652,7 @@ interface JQuery extends Iterable { * Bind an event handler to the "dblclick" JavaScript event, or trigger that event on an element. * * @param handler A function to execute each time the event is triggered. - * @see {@link https://api.jquery.com/dblclick/} + * @see \`{@link https://api.jquery.com/dblclick/ }\` * @since 1.0 * @deprecated 3.3 */ @@ -3664,7 +3662,7 @@ interface JQuery extends Iterable { * * @param duration An integer indicating the number of milliseconds to delay execution of the next item in the queue. * @param queueName A string containing the name of the queue. Defaults to fx, the standard effects queue. - * @see {@link https://api.jquery.com/delay/} + * @see \`{@link https://api.jquery.com/delay/ }\` * @since 1.4 */ delay(duration: JQuery.Duration, queueName?: string): this; @@ -3677,7 +3675,7 @@ interface JQuery extends Iterable { * "keydown," or custom event names. * @param eventData An object containing data that will be passed to the event handler. * @param handler A function to execute each time the event is triggered. - * @see {@link https://api.jquery.com/delegate/} + * @see \`{@link https://api.jquery.com/delegate/ }\` * @since 1.4.2 * @deprecated 3.0 */ @@ -3693,7 +3691,7 @@ interface JQuery extends Iterable { * @param eventType A string containing one or more space-separated JavaScript event types, such as "click" or * "keydown," or custom event names. * @param handler A function to execute each time the event is triggered. - * @see {@link https://api.jquery.com/delegate/} + * @see \`{@link https://api.jquery.com/delegate/ }\` * @since 1.4.2 * @deprecated 3.0 */ @@ -3706,7 +3704,7 @@ interface JQuery extends Iterable { * * @param selector A selector to filter the elements that trigger the event. * @param events A plain object of one or more event types and functions to execute for them. - * @see {@link https://api.jquery.com/delegate/} + * @see \`{@link https://api.jquery.com/delegate/ }\` * @since 1.4.3 * @deprecated 3.0 */ @@ -3716,7 +3714,7 @@ interface JQuery extends Iterable { * Execute the next function on the queue for the matched elements. * * @param queueName A string containing the name of the queue. Defaults to fx, the standard effects queue. - * @see {@link https://api.jquery.com/dequeue/} + * @see \`{@link https://api.jquery.com/dequeue/ }\` * @since 1.2 */ dequeue(queueName?: string): this; @@ -3724,7 +3722,7 @@ interface JQuery extends Iterable { * Remove the set of matched elements from the DOM. * * @param selector A selector expression that filters the set of matched elements to be removed. - * @see {@link https://api.jquery.com/detach/} + * @see \`{@link https://api.jquery.com/detach/ }\` * @since 1.4 */ detach(selector?: JQuery.Selector): this; @@ -3732,14 +3730,14 @@ interface JQuery extends Iterable { * Iterate over a jQuery object, executing a function for each matched element. * * @param fn A function to execute for each matched element. - * @see {@link https://api.jquery.com/each/} + * @see \`{@link https://api.jquery.com/each/ }\` * @since 1.0 */ each(fn: (this: TElement, index: number, element: TElement) => void | false): this; /** * Remove all child nodes of the set of matched elements from the DOM. * - * @see {@link https://api.jquery.com/empty/} + * @see \`{@link https://api.jquery.com/empty/ }\` * @since 1.0 */ empty(): this; @@ -3747,7 +3745,7 @@ interface JQuery extends Iterable { * End the most recent filtering operation in the current chain and return the set of matched elements * to its previous state. * - * @see {@link https://api.jquery.com/end/} + * @see \`{@link https://api.jquery.com/end/ }\` * @since 1.0 */ end(): this; @@ -3756,7 +3754,7 @@ interface JQuery extends Iterable { * * @param index An integer indicating the 0-based position of the element. * An integer indicating the position of the element, counting backwards from the last element in the set. - * @see {@link https://api.jquery.com/eq/} + * @see \`{@link https://api.jquery.com/eq/ }\` * @since 1.1.2 * @since 1.4 */ @@ -3765,7 +3763,7 @@ interface JQuery extends Iterable { * Merge the contents of an object onto the jQuery prototype to provide new jQuery instance methods. * * @param obj An object to merge onto the jQuery prototype. - * @see {@link https://api.jquery.com/jQuery.fn.extend/} + * @see \`{@link https://api.jquery.com/jQuery.fn.extend/ }\` * @since 1.0 */ extend(obj: object): this; @@ -3775,7 +3773,7 @@ interface JQuery extends Iterable { * @param duration A string or number determining how long the animation will run. * @param easing A string indicating which easing function to use for the transition. * @param complete A function to call once the animation is complete, called once per matched element. - * @see {@link https://api.jquery.com/fadeIn/} + * @see \`{@link https://api.jquery.com/fadeIn/ }\` * @since 1.4.3 */ fadeIn(duration: JQuery.Duration, easing: string, complete?: (this: TElement) => void): this; @@ -3785,7 +3783,7 @@ interface JQuery extends Iterable { * @param duration_easing A string or number determining how long the animation will run. * A string indicating which easing function to use for the transition. * @param complete A function to call once the animation is complete, called once per matched element. - * @see {@link https://api.jquery.com/fadeIn/} + * @see \`{@link https://api.jquery.com/fadeIn/ }\` * @since 1.0 * @since 1.4.3 */ @@ -3797,7 +3795,7 @@ interface JQuery extends Iterable { * A string indicating which easing function to use for the transition. * A function to call once the animation is complete, called once per matched element. * A map of additional options to pass to the method. - * @see {@link https://api.jquery.com/fadeIn/} + * @see \`{@link https://api.jquery.com/fadeIn/ }\` * @since 1.0 * @since 1.4.3 */ @@ -3808,7 +3806,7 @@ interface JQuery extends Iterable { * @param duration A string or number determining how long the animation will run. * @param easing A string indicating which easing function to use for the transition. * @param complete A function to call once the animation is complete, called once per matched element. - * @see {@link https://api.jquery.com/fadeOut/} + * @see \`{@link https://api.jquery.com/fadeOut/ }\` * @since 1.4.3 */ fadeOut(duration: JQuery.Duration, easing: string, complete?: (this: TElement) => void): this; @@ -3818,7 +3816,7 @@ interface JQuery extends Iterable { * @param duration_easing A string or number determining how long the animation will run. * A string indicating which easing function to use for the transition. * @param complete A function to call once the animation is complete, called once per matched element. - * @see {@link https://api.jquery.com/fadeOut/} + * @see \`{@link https://api.jquery.com/fadeOut/ }\` * @since 1.0 * @since 1.4.3 */ @@ -3830,7 +3828,7 @@ interface JQuery extends Iterable { * A string indicating which easing function to use for the transition. * A function to call once the animation is complete, called once per matched element. * A map of additional options to pass to the method. - * @see {@link https://api.jquery.com/fadeOut/} + * @see \`{@link https://api.jquery.com/fadeOut/ }\` * @since 1.0 * @since 1.4.3 */ @@ -3842,7 +3840,7 @@ interface JQuery extends Iterable { * @param opacity A number between 0 and 1 denoting the target opacity. * @param easing A string indicating which easing function to use for the transition. * @param complete A function to call once the animation is complete, called once per matched element. - * @see {@link https://api.jquery.com/fadeTo/} + * @see \`{@link https://api.jquery.com/fadeTo/ }\` * @since 1.4.3 */ fadeTo(duration: JQuery.Duration, opacity: number, easing: string, complete?: (this: TElement) => void): this; @@ -3852,7 +3850,7 @@ interface JQuery extends Iterable { * @param duration A string or number determining how long the animation will run. * @param opacity A number between 0 and 1 denoting the target opacity. * @param complete A function to call once the animation is complete, called once per matched element. - * @see {@link https://api.jquery.com/fadeTo/} + * @see \`{@link https://api.jquery.com/fadeTo/ }\` * @since 1.0 */ fadeTo(duration: JQuery.Duration, opacity: number, complete?: (this: TElement) => void): this; @@ -3862,7 +3860,7 @@ interface JQuery extends Iterable { * @param duration A string or number determining how long the animation will run. * @param easing A string indicating which easing function to use for the transition. * @param complete A function to call once the animation is complete, called once per matched element. - * @see {@link https://api.jquery.com/fadeToggle/} + * @see \`{@link https://api.jquery.com/fadeToggle/ }\` * @since 1.4.4 */ fadeToggle(duration: JQuery.Duration, easing: string, complete?: (this: TElement) => void): this; @@ -3872,7 +3870,7 @@ interface JQuery extends Iterable { * @param duration_easing A string or number determining how long the animation will run. * A string indicating which easing function to use for the transition. * @param complete A function to call once the animation is complete, called once per matched element. - * @see {@link https://api.jquery.com/fadeToggle/} + * @see \`{@link https://api.jquery.com/fadeToggle/ }\` * @since 1.0 * @since 1.4.3 */ @@ -3884,7 +3882,7 @@ interface JQuery extends Iterable { * A string indicating which easing function to use for the transition. * A function to call once the animation is complete, called once per matched element. * A map of additional options to pass to the method. - * @see {@link https://api.jquery.com/fadeToggle/} + * @see \`{@link https://api.jquery.com/fadeToggle/ }\` * @since 1.0 * @since 1.4.3 */ @@ -3896,7 +3894,7 @@ interface JQuery extends Iterable { * One or more DOM elements to match the current set of elements against. * An existing jQuery object to match the current set of elements against. * A function used as a test for each element in the set. this is the current DOM element. - * @see {@link https://api.jquery.com/filter/} + * @see \`{@link https://api.jquery.com/filter/ }\` * @since 1.0 * @since 1.4 */ @@ -3907,7 +3905,7 @@ interface JQuery extends Iterable { * * @param selector A string containing a selector expression to match elements against. * An element or a jQuery object to match elements against. - * @see {@link https://api.jquery.com/find/} + * @see \`{@link https://api.jquery.com/find/ }\` * @since 1.0 * @since 1.6 */ @@ -3917,14 +3915,14 @@ interface JQuery extends Iterable { * the matched elements. * * @param queue The name of the queue in which to stop animations. - * @see {@link https://api.jquery.com/finish/} + * @see \`{@link https://api.jquery.com/finish/ }\` * @since 1.9 */ finish(queue?: string): this; /** * Reduce the set of matched elements to the first in the set. * - * @see {@link https://api.jquery.com/first/} + * @see \`{@link https://api.jquery.com/first/ }\` * @since 1.4 */ first(): this; @@ -3933,7 +3931,7 @@ interface JQuery extends Iterable { * * @param eventData An object containing data that will be passed to the event handler. * @param handler A function to execute each time the event is triggered. - * @see {@link https://api.jquery.com/focus/} + * @see \`{@link https://api.jquery.com/focus/ }\` * @since 1.4.3 * @deprecated 3.3 */ @@ -3943,7 +3941,7 @@ interface JQuery extends Iterable { * Bind an event handler to the "focus" JavaScript event, or trigger that event on an element. * * @param handler A function to execute each time the event is triggered. - * @see {@link https://api.jquery.com/focus/} + * @see \`{@link https://api.jquery.com/focus/ }\` * @since 1.0 * @deprecated 3.3 */ @@ -3953,7 +3951,7 @@ interface JQuery extends Iterable { * * @param eventData An object containing data that will be passed to the event handler. * @param handler A function to execute each time the event is triggered. - * @see {@link https://api.jquery.com/focusin/} + * @see \`{@link https://api.jquery.com/focusin/ }\` * @since 1.4.3 * @deprecated 3.3 */ @@ -3963,7 +3961,7 @@ interface JQuery extends Iterable { * Bind an event handler to the "focusin" event. * * @param handler A function to execute each time the event is triggered. - * @see {@link https://api.jquery.com/focusin/} + * @see \`{@link https://api.jquery.com/focusin/ }\` * @since 1.4 * @deprecated 3.3 */ @@ -3973,7 +3971,7 @@ interface JQuery extends Iterable { * * @param eventData An object containing data that will be passed to the event handler. * @param handler A function to execute each time the event is triggered. - * @see {@link https://api.jquery.com/focusout/} + * @see \`{@link https://api.jquery.com/focusout/ }\` * @since 1.4.3 * @deprecated 3.3 */ @@ -3983,7 +3981,7 @@ interface JQuery extends Iterable { * Bind an event handler to the "focusout" JavaScript event. * * @param handler A function to execute each time the event is triggered. - * @see {@link https://api.jquery.com/focusout/} + * @see \`{@link https://api.jquery.com/focusout/ }\` * @since 1.4 * @deprecated 3.3 */ @@ -3992,14 +3990,14 @@ interface JQuery extends Iterable { * Retrieve one of the elements matched by the jQuery object. * * @param index A zero-based integer indicating which element to retrieve. - * @see {@link https://api.jquery.com/get/} + * @see \`{@link https://api.jquery.com/get/ }\` * @since 1.0 */ get(index: number): TElement; /** * Retrieve the elements matched by the jQuery object. * - * @see {@link https://api.jquery.com/get/} + * @see \`{@link https://api.jquery.com/get/ }\` * @since 1.0 */ get(): TElement[]; @@ -4008,7 +4006,7 @@ interface JQuery extends Iterable { * * @param selector A string containing a selector expression to match elements against. * A DOM element to match elements against. - * @see {@link https://api.jquery.com/has/} + * @see \`{@link https://api.jquery.com/has/ }\` * @since 1.4 */ has(selector: string | Element): this; @@ -4016,7 +4014,7 @@ interface JQuery extends Iterable { * Determine whether any of the matched elements are assigned the given class. * * @param className The class name to search for. - * @see {@link https://api.jquery.com/hasClass/} + * @see \`{@link https://api.jquery.com/hasClass/ }\` * @since 1.2 */ hasClass(className: string): boolean; @@ -4027,7 +4025,7 @@ interface JQuery extends Iterable { * appended (as a string). * A function returning the height to set. Receives the index position of the element in the set and * the old height as arguments. Within the function, this refers to the current element in the set. - * @see {@link https://api.jquery.com/height/} + * @see \`{@link https://api.jquery.com/height/ }\` * @since 1.0 * @since 1.4.1 */ @@ -4035,7 +4033,7 @@ interface JQuery extends Iterable { /** * Get the current computed height for the first element in the set of matched elements. * - * @see {@link https://api.jquery.com/height/} + * @see \`{@link https://api.jquery.com/height/ }\` * @since 1.0 */ height(): number | undefined; @@ -4045,7 +4043,7 @@ interface JQuery extends Iterable { * @param duration A string or number determining how long the animation will run. * @param easing A string indicating which easing function to use for the transition. * @param complete A function to call once the animation is complete, called once per matched element. - * @see {@link https://api.jquery.com/hide/} + * @see \`{@link https://api.jquery.com/hide/ }\` * @since 1.4.3 */ hide(duration: JQuery.Duration, easing: string, complete: (this: TElement) => void): this; @@ -4055,7 +4053,7 @@ interface JQuery extends Iterable { * @param duration A string or number determining how long the animation will run. * @param easing_complete A string indicating which easing function to use for the transition. * A function to call once the animation is complete, called once per matched element. - * @see {@link https://api.jquery.com/hide/} + * @see \`{@link https://api.jquery.com/hide/ }\` * @since 1.0 * @since 1.4.3 */ @@ -4066,7 +4064,7 @@ interface JQuery extends Iterable { * @param duration_complete_options A string or number determining how long the animation will run. * A function to call once the animation is complete, called once per matched element. * A map of additional options to pass to the method. - * @see {@link https://api.jquery.com/hide/} + * @see \`{@link https://api.jquery.com/hide/ }\` * @since 1.0 */ hide(duration_complete_options?: JQuery.Duration | ((this: TElement) => void) | JQuery.EffectsOptions): this; @@ -4076,7 +4074,7 @@ interface JQuery extends Iterable { * * @param handlerInOut A function to execute when the mouse pointer enters or leaves the element. * @param handlerOut A function to execute when the mouse pointer leaves the element. - * @see {@link https://api.jquery.com/hover/} + * @see \`{@link https://api.jquery.com/hover/ }\` * @since 1.0 * @since 1.4 */ @@ -4090,7 +4088,7 @@ interface JQuery extends Iterable { * A function returning the HTML content to set. Receives the index position of the element in the set * and the old HTML value as arguments. jQuery empties the element before calling the function; use the * oldhtml argument to reference the previous content. Within the function, this refers to the current element in the set. - * @see {@link https://api.jquery.com/html/} + * @see \`{@link https://api.jquery.com/html/ }\` * @since 1.0 * @since 1.4 */ @@ -4098,7 +4096,7 @@ interface JQuery extends Iterable { /** * Get the HTML contents of the first element in the set of matched elements. * - * @see {@link https://api.jquery.com/html/} + * @see \`{@link https://api.jquery.com/html/ }\` * @since 1.0 */ html(): string; @@ -4107,7 +4105,7 @@ interface JQuery extends Iterable { * * @param element The DOM element or first element within the jQuery object to look for. * A selector representing a jQuery collection in which to look for an element. - * @see {@link https://api.jquery.com/index/} + * @see \`{@link https://api.jquery.com/index/ }\` * @since 1.0 * @since 1.4 */ @@ -4120,7 +4118,7 @@ interface JQuery extends Iterable { * A function returning the inner height (including padding but not border) to set. Receives the index * position of the element in the set and the old inner height as arguments. Within the function, this * refers to the current element in the set. - * @see {@link https://api.jquery.com/innerHeight/} + * @see \`{@link https://api.jquery.com/innerHeight/ }\` * @since 1.8.0 */ innerHeight(value: string | number | ((this: TElement, index: number, height: number) => string | number)): this; @@ -4128,7 +4126,7 @@ interface JQuery extends Iterable { * Get the current computed height for the first element in the set of matched elements, including * padding but not border. * - * @see {@link https://api.jquery.com/innerHeight/} + * @see \`{@link https://api.jquery.com/innerHeight/ }\` * @since 1.2.6 */ innerHeight(): number | undefined; @@ -4140,7 +4138,7 @@ interface JQuery extends Iterable { * A function returning the inner width (including padding but not border) to set. Receives the index * position of the element in the set and the old inner width as arguments. Within the function, this * refers to the current element in the set. - * @see {@link https://api.jquery.com/innerWidth/} + * @see \`{@link https://api.jquery.com/innerWidth/ }\` * @since 1.8.0 */ innerWidth(value: string | number | ((this: TElement, index: number, width: number) => string | number)): this; @@ -4148,7 +4146,7 @@ interface JQuery extends Iterable { * Get the current computed inner width for the first element in the set of matched elements, including * padding but not border. * - * @see {@link https://api.jquery.com/innerWidth/} + * @see \`{@link https://api.jquery.com/innerWidth/ }\` * @since 1.2.6 */ innerWidth(): number | undefined; @@ -4157,7 +4155,7 @@ interface JQuery extends Iterable { * * @param target A selector, element, array of elements, HTML string, or jQuery object; the matched set of elements * will be inserted after the element(s) specified by this parameter. - * @see {@link https://api.jquery.com/insertAfter/} + * @see \`{@link https://api.jquery.com/insertAfter/ }\` * @since 1.0 */ insertAfter(target: JQuery.Selector | JQuery.htmlString | JQuery.TypeOrArray | JQuery): this; @@ -4166,7 +4164,7 @@ interface JQuery extends Iterable { * * @param target A selector, element, array of elements, HTML string, or jQuery object; the matched set of elements * will be inserted before the element(s) specified by this parameter. - * @see {@link https://api.jquery.com/insertBefore/} + * @see \`{@link https://api.jquery.com/insertBefore/ }\` * @since 1.0 */ insertBefore(target: JQuery.Selector | JQuery.htmlString | JQuery.TypeOrArray | JQuery): this; @@ -4180,7 +4178,7 @@ interface JQuery extends Iterable { * function, this refers to the current DOM element. * An existing jQuery object to match the current set of elements against. * One or more elements to match the current set of elements against. - * @see {@link https://api.jquery.com/is/} + * @see \`{@link https://api.jquery.com/is/ }\` * @since 1.0 * @since 1.6 */ @@ -4190,7 +4188,7 @@ interface JQuery extends Iterable { * * @param eventData An object containing data that will be passed to the event handler. * @param handler A function to execute each time the event is triggered. - * @see {@link https://api.jquery.com/keydown/} + * @see \`{@link https://api.jquery.com/keydown/ }\` * @since 1.4.3 * @deprecated 3.3 */ @@ -4200,7 +4198,7 @@ interface JQuery extends Iterable { * Bind an event handler to the "keydown" JavaScript event, or trigger that event on an element. * * @param handler A function to execute each time the event is triggered. - * @see {@link https://api.jquery.com/keydown/} + * @see \`{@link https://api.jquery.com/keydown/ }\` * @since 1.0 * @deprecated 3.3 */ @@ -4210,7 +4208,7 @@ interface JQuery extends Iterable { * * @param eventData An object containing data that will be passed to the event handler. * @param handler A function to execute each time the event is triggered. - * @see {@link https://api.jquery.com/keypress/} + * @see \`{@link https://api.jquery.com/keypress/ }\` * @since 1.4.3 * @deprecated 3.3 */ @@ -4220,7 +4218,7 @@ interface JQuery extends Iterable { * Bind an event handler to the "keypress" JavaScript event, or trigger that event on an element. * * @param handler A function to execute each time the event is triggered. - * @see {@link https://api.jquery.com/keypress/} + * @see \`{@link https://api.jquery.com/keypress/ }\` * @since 1.0 * @deprecated 3.3 */ @@ -4230,7 +4228,7 @@ interface JQuery extends Iterable { * * @param eventData An object containing data that will be passed to the event handler. * @param handler A function to execute each time the event is triggered. - * @see {@link https://api.jquery.com/keyup/} + * @see \`{@link https://api.jquery.com/keyup/ }\` * @since 1.4.3 * @deprecated 3.3 */ @@ -4240,7 +4238,7 @@ interface JQuery extends Iterable { * Bind an event handler to the "keyup" JavaScript event, or trigger that event on an element. * * @param handler A function to execute each time the event is triggered. - * @see {@link https://api.jquery.com/keyup/} + * @see \`{@link https://api.jquery.com/keyup/ }\` * @since 1.0 * @deprecated 3.3 */ @@ -4248,7 +4246,7 @@ interface JQuery extends Iterable { /** * Reduce the set of matched elements to the final one in the set. * - * @see {@link https://api.jquery.com/last/} + * @see \`{@link https://api.jquery.com/last/ }\` * @since 1.4 */ last(): this; @@ -4258,7 +4256,7 @@ interface JQuery extends Iterable { * @param url A string containing the URL to which the request is sent. * @param data A plain object or string that is sent to the server with the request. * @param complete A callback function that is executed when the request completes. - * @see {@link https://api.jquery.com/load/} + * @see \`{@link https://api.jquery.com/load/ }\` * @since 1.0 */ load(url: string, @@ -4270,7 +4268,7 @@ interface JQuery extends Iterable { * @param url A string containing the URL to which the request is sent. * @param complete_data A callback function that is executed when the request completes. * A plain object or string that is sent to the server with the request. - * @see {@link https://api.jquery.com/load/} + * @see \`{@link https://api.jquery.com/load/ }\` * @since 1.0 */ load(url: string, @@ -4280,7 +4278,7 @@ interface JQuery extends Iterable { * containing the return values. * * @param callback A function object that will be invoked for each element in the current set. - * @see {@link https://api.jquery.com/map/} + * @see \`{@link https://api.jquery.com/map/ }\` * @since 1.2 */ map(callback: (this: TElement, index: number, domElement: TElement) => JQuery.TypeOrArray | null | undefined): JQuery; @@ -4289,7 +4287,7 @@ interface JQuery extends Iterable { * * @param eventData An object containing data that will be passed to the event handler. * @param handler A function to execute each time the event is triggered. - * @see {@link https://api.jquery.com/mousedown/} + * @see \`{@link https://api.jquery.com/mousedown/ }\` * @since 1.4.3 * @deprecated 3.3 */ @@ -4299,7 +4297,7 @@ interface JQuery extends Iterable { * Bind an event handler to the "mousedown" JavaScript event, or trigger that event on an element. * * @param handler A function to execute each time the event is triggered. - * @see {@link https://api.jquery.com/mousedown/} + * @see \`{@link https://api.jquery.com/mousedown/ }\` * @since 1.0 * @deprecated 3.3 */ @@ -4309,7 +4307,7 @@ interface JQuery extends Iterable { * * @param eventData An object containing data that will be passed to the event handler. * @param handler A function to execute each time the event is triggered. - * @see {@link https://api.jquery.com/mouseenter/} + * @see \`{@link https://api.jquery.com/mouseenter/ }\` * @since 1.4.3 * @deprecated 3.3 */ @@ -4319,7 +4317,7 @@ interface JQuery extends Iterable { * Bind an event handler to be fired when the mouse enters an element, or trigger that handler on an element. * * @param handler A function to execute each time the event is triggered. - * @see {@link https://api.jquery.com/mouseenter/} + * @see \`{@link https://api.jquery.com/mouseenter/ }\` * @since 1.0 * @deprecated 3.3 */ @@ -4329,7 +4327,7 @@ interface JQuery extends Iterable { * * @param eventData An object containing data that will be passed to the event handler. * @param handler A function to execute each time the event is triggered. - * @see {@link https://api.jquery.com/mouseleave/} + * @see \`{@link https://api.jquery.com/mouseleave/ }\` * @since 1.4.3 * @deprecated 3.3 */ @@ -4339,7 +4337,7 @@ interface JQuery extends Iterable { * Bind an event handler to be fired when the mouse leaves an element, or trigger that handler on an element. * * @param handler A function to execute each time the event is triggered. - * @see {@link https://api.jquery.com/mouseleave/} + * @see \`{@link https://api.jquery.com/mouseleave/ }\` * @since 1.0 * @deprecated 3.3 */ @@ -4349,7 +4347,7 @@ interface JQuery extends Iterable { * * @param eventData An object containing data that will be passed to the event handler. * @param handler A function to execute each time the event is triggered. - * @see {@link https://api.jquery.com/mousemove/} + * @see \`{@link https://api.jquery.com/mousemove/ }\` * @since 1.4.3 * @deprecated 3.3 */ @@ -4359,7 +4357,7 @@ interface JQuery extends Iterable { * Bind an event handler to the "mousemove" JavaScript event, or trigger that event on an element. * * @param handler A function to execute each time the event is triggered. - * @see {@link https://api.jquery.com/mousemove/} + * @see \`{@link https://api.jquery.com/mousemove/ }\` * @since 1.0 * @deprecated 3.3 */ @@ -4369,7 +4367,7 @@ interface JQuery extends Iterable { * * @param eventData An object containing data that will be passed to the event handler. * @param handler A function to execute each time the event is triggered. - * @see {@link https://api.jquery.com/mouseout/} + * @see \`{@link https://api.jquery.com/mouseout/ }\` * @since 1.4.3 * @deprecated 3.3 */ @@ -4379,7 +4377,7 @@ interface JQuery extends Iterable { * Bind an event handler to the "mouseout" JavaScript event, or trigger that event on an element. * * @param handler A function to execute each time the event is triggered. - * @see {@link https://api.jquery.com/mouseout/} + * @see \`{@link https://api.jquery.com/mouseout/ }\` * @since 1.0 * @deprecated 3.3 */ @@ -4389,7 +4387,7 @@ interface JQuery extends Iterable { * * @param eventData An object containing data that will be passed to the event handler. * @param handler A function to execute each time the event is triggered. - * @see {@link https://api.jquery.com/mouseover/} + * @see \`{@link https://api.jquery.com/mouseover/ }\` * @since 1.4.3 * @deprecated 3.3 */ @@ -4399,7 +4397,7 @@ interface JQuery extends Iterable { * Bind an event handler to the "mouseover" JavaScript event, or trigger that event on an element. * * @param handler A function to execute each time the event is triggered. - * @see {@link https://api.jquery.com/mouseover/} + * @see \`{@link https://api.jquery.com/mouseover/ }\` * @since 1.0 * @deprecated 3.3 */ @@ -4409,7 +4407,7 @@ interface JQuery extends Iterable { * * @param eventData An object containing data that will be passed to the event handler. * @param handler A function to execute each time the event is triggered. - * @see {@link https://api.jquery.com/mouseup/} + * @see \`{@link https://api.jquery.com/mouseup/ }\` * @since 1.4.3 * @deprecated 3.3 */ @@ -4419,7 +4417,7 @@ interface JQuery extends Iterable { * Bind an event handler to the "mouseup" JavaScript event, or trigger that event on an element. * * @param handler A function to execute each time the event is triggered. - * @see {@link https://api.jquery.com/mouseup/} + * @see \`{@link https://api.jquery.com/mouseup/ }\` * @since 1.0 * @deprecated 3.3 */ @@ -4429,7 +4427,7 @@ interface JQuery extends Iterable { * is provided, it retrieves the next sibling only if it matches that selector. * * @param selector A string containing a selector expression to match elements against. - * @see {@link https://api.jquery.com/next/} + * @see \`{@link https://api.jquery.com/next/ }\` * @since 1.0 */ next(selector?: JQuery.Selector): this; @@ -4437,7 +4435,7 @@ interface JQuery extends Iterable { * Get all following siblings of each element in the set of matched elements, optionally filtered by a selector. * * @param selector A string containing a selector expression to match elements against. - * @see {@link https://api.jquery.com/nextAll/} + * @see \`{@link https://api.jquery.com/nextAll/ }\` * @since 1.2 */ nextAll(selector?: string): this; @@ -4448,7 +4446,7 @@ interface JQuery extends Iterable { * @param selector A string containing a selector expression to indicate where to stop matching following sibling elements. * A DOM node or jQuery object indicating where to stop matching following sibling elements. * @param filter A string containing a selector expression to match elements against. - * @see {@link https://api.jquery.com/nextUntil/} + * @see \`{@link https://api.jquery.com/nextUntil/ }\` * @since 1.4 * @since 1.6 */ @@ -4461,7 +4459,7 @@ interface JQuery extends Iterable { * element's index in the jQuery collection, and element, which is the DOM element. Within the * function, this refers to the current DOM element. * An existing jQuery object to match the current set of elements against. - * @see {@link https://api.jquery.com/not/} + * @see \`{@link https://api.jquery.com/not/ }\` * @since 1.0 * @since 1.4 */ @@ -4473,7 +4471,7 @@ interface JQuery extends Iterable { * "click", "keydown.myPlugin", or ".myPlugin". * @param selector A selector which should match the one originally passed to .on() when attaching event handlers. * @param handler A function to execute each time the event is triggered. - * @see {@link https://api.jquery.com/off/} + * @see \`{@link https://api.jquery.com/off/ }\` * @since 1.7 */ off(events: string, selector: JQuery.Selector, handler: JQuery.EventHandlerBase> | false): this; @@ -4484,7 +4482,7 @@ interface JQuery extends Iterable { * "click", "keydown.myPlugin", or ".myPlugin". * @param selector_handler A selector which should match the one originally passed to .on() when attaching event handlers. * A function to execute each time the event is triggered. - * @see {@link https://api.jquery.com/off/} + * @see \`{@link https://api.jquery.com/off/ }\` * @since 1.7 */ off(events: string, selector_handler?: JQuery.Selector | JQuery.EventHandlerBase> | false): this; @@ -4494,7 +4492,7 @@ interface JQuery extends Iterable { * @param events An object where the string keys represent one or more space-separated event types and optional * namespaces, and the values represent handler functions previously attached for the event(s). * @param selector A selector which should match the one originally passed to .on() when attaching event handlers. - * @see {@link https://api.jquery.com/off/} + * @see \`{@link https://api.jquery.com/off/ }\` * @since 1.7 */ off(events: JQuery.PlainObject> | false>, selector?: JQuery.Selector): this; @@ -4502,7 +4500,7 @@ interface JQuery extends Iterable { * Remove an event handler. * * @param event A jQuery.Event object. - * @see {@link https://api.jquery.com/off/} + * @see \`{@link https://api.jquery.com/off/ }\` * @since 1.7 */ off(event?: JQuery.Event): this; @@ -4514,21 +4512,21 @@ interface JQuery extends Iterable { * A function to return the coordinates to set. Receives the index of the element in the collection as * the first argument and the current coordinates as the second argument. The function should return an * object with the new top and left properties. - * @see {@link https://api.jquery.com/offset/} + * @see \`{@link https://api.jquery.com/offset/ }\` * @since 1.4 */ offset(coordinates: JQuery.Coordinates | ((this: TElement, index: number, coords: JQuery.Coordinates) => JQuery.Coordinates)): this; /** * Get the current coordinates of the first element in the set of matched elements, relative to the document. * - * @see {@link https://api.jquery.com/offset/} + * @see \`{@link https://api.jquery.com/offset/ }\` * @since 1.2 */ offset(): JQuery.Coordinates | undefined; /** * Get the closest ancestor element that is positioned. * - * @see {@link https://api.jquery.com/offsetParent/} + * @see \`{@link https://api.jquery.com/offsetParent/ }\` * @since 1.2.6 */ offsetParent(): this; @@ -4540,7 +4538,7 @@ interface JQuery extends Iterable { * selector is null or omitted, the event is always triggered when it reaches the selected element. * @param data Data to be passed to the handler in event.data when an event is triggered. * @param handler A function to execute when the event is triggered. - * @see {@link https://api.jquery.com/on/} + * @see \`{@link https://api.jquery.com/on/ }\` * @since 1.7 */ on(events: string, @@ -4555,7 +4553,7 @@ interface JQuery extends Iterable { * selector is null or omitted, the event is always triggered when it reaches the selected element. * @param data Data to be passed to the handler in event.data when an event is triggered. * @param handler A function to execute when the event is triggered. - * @see {@link https://api.jquery.com/on/} + * @see \`{@link https://api.jquery.com/on/ }\` * @since 1.7 */ on(events: string, @@ -4570,7 +4568,7 @@ interface JQuery extends Iterable { * selector is null or omitted, the event is always triggered when it reaches the selected element. * @param handler A function to execute when the event is triggered. The value false is also allowed as a shorthand * for a function that simply does return false. - * @see {@link https://api.jquery.com/on/} + * @see \`{@link https://api.jquery.com/on/ }\` * @since 1.7 */ on(events: string, @@ -4583,7 +4581,7 @@ interface JQuery extends Iterable { * @param selector A selector string to filter the descendants of the selected elements that trigger the event. If the * selector is null or omitted, the event is always triggered when it reaches the selected element. * @param handler A function to execute when the event is triggered. - * @see {@link https://api.jquery.com/on/} + * @see \`{@link https://api.jquery.com/on/ }\` * @since 1.7 */ on(events: string, @@ -4595,7 +4593,7 @@ interface JQuery extends Iterable { * @param events One or more space-separated event types and optional namespaces, such as "click" or "keydown.myPlugin". * @param data Data to be passed to the handler in event.data when an event is triggered. * @param handler A function to execute when the event is triggered. - * @see {@link https://api.jquery.com/on/} + * @see \`{@link https://api.jquery.com/on/ }\` * @since 1.7 */ on(events: string, @@ -4607,7 +4605,7 @@ interface JQuery extends Iterable { * @param events One or more space-separated event types and optional namespaces, such as "click" or "keydown.myPlugin". * @param data Data to be passed to the handler in event.data when an event is triggered. * @param handler A function to execute when the event is triggered. - * @see {@link https://api.jquery.com/on/} + * @see \`{@link https://api.jquery.com/on/ }\` * @since 1.7 */ on(events: string, @@ -4619,7 +4617,7 @@ interface JQuery extends Iterable { * @param events One or more space-separated event types and optional namespaces, such as "click" or "keydown.myPlugin". * @param handler A function to execute when the event is triggered. The value false is also allowed as a shorthand * for a function that simply does return false. - * @see {@link https://api.jquery.com/on/} + * @see \`{@link https://api.jquery.com/on/ }\` * @since 1.7 */ on(events: string, @@ -4629,7 +4627,7 @@ interface JQuery extends Iterable { * * @param events One or more space-separated event types and optional namespaces, such as "click" or "keydown.myPlugin". * @param handler A function to execute when the event is triggered. - * @see {@link https://api.jquery.com/on/} + * @see \`{@link https://api.jquery.com/on/ }\` * @since 1.7 */ on(events: string, @@ -4642,7 +4640,7 @@ interface JQuery extends Iterable { * @param selector A selector string to filter the descendants of the selected elements that will call the handler. If * the selector is null or omitted, the handler is always called when it reaches the selected element. * @param data Data to be passed to the handler in event.data when an event occurs. - * @see {@link https://api.jquery.com/on/} + * @see \`{@link https://api.jquery.com/on/ }\` * @since 1.7 */ on(events: JQuery.PlainObject | JQuery.EventHandlerBase> | false>, @@ -4655,7 +4653,7 @@ interface JQuery extends Iterable { * namespaces, and the values represent a handler function to be called for the event(s). * @param selector A selector string to filter the descendants of the selected elements that will call the handler. If * the selector is null or omitted, the handler is always called when it reaches the selected element. - * @see {@link https://api.jquery.com/on/} + * @see \`{@link https://api.jquery.com/on/ }\` * @since 1.7 */ on(events: JQuery.PlainObject | JQuery.EventHandlerBase> | false>, @@ -4666,7 +4664,7 @@ interface JQuery extends Iterable { * @param events An object in which the string keys represent one or more space-separated event types and optional * namespaces, and the values represent a handler function to be called for the event(s). * @param data Data to be passed to the handler in event.data when an event occurs. - * @see {@link https://api.jquery.com/on/} + * @see \`{@link https://api.jquery.com/on/ }\` * @since 1.7 */ on(events: JQuery.PlainObject | JQuery.EventHandlerBase> | false>, @@ -4676,7 +4674,7 @@ interface JQuery extends Iterable { * * @param events An object in which the string keys represent one or more space-separated event types and optional * namespaces, and the values represent a handler function to be called for the event(s). - * @see {@link https://api.jquery.com/on/} + * @see \`{@link https://api.jquery.com/on/ }\` * @since 1.7 */ on(events: JQuery.PlainObject | JQuery.EventHandlerBase> | false>): this; @@ -4688,7 +4686,7 @@ interface JQuery extends Iterable { * selector is null or omitted, the event is always triggered when it reaches the selected element. * @param data Data to be passed to the handler in event.data when an event is triggered. * @param handler A function to execute when the event is triggered. - * @see {@link https://api.jquery.com/one/} + * @see \`{@link https://api.jquery.com/one/ }\` * @since 1.7 */ one(events: string, @@ -4703,7 +4701,7 @@ interface JQuery extends Iterable { * selector is null or omitted, the event is always triggered when it reaches the selected element. * @param handler A function to execute when the event is triggered. The value false is also allowed as a shorthand * for a function that simply does return false. - * @see {@link https://api.jquery.com/one/} + * @see \`{@link https://api.jquery.com/one/ }\` * @since 1.7 */ one(events: string, @@ -4715,7 +4713,7 @@ interface JQuery extends Iterable { * @param events One or more space-separated event types and optional namespaces, such as "click" or "keydown.myPlugin". * @param data Data to be passed to the handler in event.data when an event is triggered. * @param handler A function to execute when the event is triggered. - * @see {@link https://api.jquery.com/one/} + * @see \`{@link https://api.jquery.com/one/ }\` * @since 1.7 */ one(events: string, @@ -4727,7 +4725,7 @@ interface JQuery extends Iterable { * @param events One or more space-separated event types and optional namespaces, such as "click" or "keydown.myPlugin". * @param handler A function to execute when the event is triggered. The value false is also allowed as a shorthand * for a function that simply does return false. - * @see {@link https://api.jquery.com/one/} + * @see \`{@link https://api.jquery.com/one/ }\` * @since 1.7 */ one(events: string, @@ -4740,7 +4738,7 @@ interface JQuery extends Iterable { * @param selector A selector string to filter the descendants of the selected elements that will call the handler. If * the selector is null or omitted, the handler is always called when it reaches the selected element. * @param data Data to be passed to the handler in event.data when an event occurs. - * @see {@link https://api.jquery.com/one/} + * @see \`{@link https://api.jquery.com/one/ }\` * @since 1.7 */ one(events: JQuery.PlainObject | JQuery.EventHandlerBase> | false>, @@ -4753,7 +4751,7 @@ interface JQuery extends Iterable { * namespaces, and the values represent a handler function to be called for the event(s). * @param selector A selector string to filter the descendants of the selected elements that will call the handler. If * the selector is null or omitted, the handler is always called when it reaches the selected element. - * @see {@link https://api.jquery.com/one/} + * @see \`{@link https://api.jquery.com/one/ }\` * @since 1.7 */ one(events: JQuery.PlainObject | JQuery.EventHandlerBase> | false>, @@ -4764,7 +4762,7 @@ interface JQuery extends Iterable { * @param events An object in which the string keys represent one or more space-separated event types and optional * namespaces, and the values represent a handler function to be called for the event(s). * @param data Data to be passed to the handler in event.data when an event occurs. - * @see {@link https://api.jquery.com/one/} + * @see \`{@link https://api.jquery.com/one/ }\` * @since 1.7 */ one(events: JQuery.PlainObject | JQuery.EventHandlerBase> | false>, @@ -4774,7 +4772,7 @@ interface JQuery extends Iterable { * * @param events An object in which the string keys represent one or more space-separated event types and optional * namespaces, and the values represent a handler function to be called for the event(s). - * @see {@link https://api.jquery.com/one/} + * @see \`{@link https://api.jquery.com/one/ }\` * @since 1.7 */ one(events: JQuery.PlainObject | JQuery.EventHandlerBase> | false>): this; @@ -4783,7 +4781,7 @@ interface JQuery extends Iterable { * * @param value A number representing the number of pixels, or a number along with an optional unit of measure * appended (as a string). - * @see {@link https://api.jquery.com/outerHeight/} + * @see \`{@link https://api.jquery.com/outerHeight/ }\` * @since 1.8.0 */ outerHeight(value: string | number | ((this: TElement, index: number, height: number) => string | number)): this; @@ -4792,7 +4790,7 @@ interface JQuery extends Iterable { * first element in the set of matched elements. * * @param includeMargin A Boolean indicating whether to include the element's margin in the calculation. - * @see {@link https://api.jquery.com/outerHeight/} + * @see \`{@link https://api.jquery.com/outerHeight/ }\` * @since 1.2.6 */ outerHeight(includeMargin?: boolean): number | undefined; @@ -4803,7 +4801,7 @@ interface JQuery extends Iterable { * appended (as a string). * A function returning the outer width to set. Receives the index position of the element in the set * and the old outer width as arguments. Within the function, this refers to the current element in the set. - * @see {@link https://api.jquery.com/outerWidth/} + * @see \`{@link https://api.jquery.com/outerWidth/ }\` * @since 1.8.0 */ outerWidth(value: string | number | ((this: TElement, index: number, width: number) => string | number)): this; @@ -4812,7 +4810,7 @@ interface JQuery extends Iterable { * first element in the set of matched elements. * * @param includeMargin A Boolean indicating whether to include the element's margin in the calculation. - * @see {@link https://api.jquery.com/outerWidth/} + * @see \`{@link https://api.jquery.com/outerWidth/ }\` * @since 1.2.6 */ outerWidth(includeMargin?: boolean): number | undefined; @@ -4820,7 +4818,7 @@ interface JQuery extends Iterable { * Get the parent of each element in the current set of matched elements, optionally filtered by a selector. * * @param selector A string containing a selector expression to match elements against. - * @see {@link https://api.jquery.com/parent/} + * @see \`{@link https://api.jquery.com/parent/ }\` * @since 1.0 */ parent(selector?: JQuery.Selector): this; @@ -4828,7 +4826,7 @@ interface JQuery extends Iterable { * Get the ancestors of each element in the current set of matched elements, optionally filtered by a selector. * * @param selector A string containing a selector expression to match elements against. - * @see {@link https://api.jquery.com/parents/} + * @see \`{@link https://api.jquery.com/parents/ }\` * @since 1.0 */ parents(selector?: JQuery.Selector): this; @@ -4839,7 +4837,7 @@ interface JQuery extends Iterable { * @param selector A string containing a selector expression to indicate where to stop matching ancestor elements. * A DOM node or jQuery object indicating where to stop matching ancestor elements. * @param filter A string containing a selector expression to match elements against. - * @see {@link https://api.jquery.com/parentsUntil/} + * @see \`{@link https://api.jquery.com/parentsUntil/ }\` * @since 1.4 * @since 1.6 */ @@ -4847,7 +4845,7 @@ interface JQuery extends Iterable { /** * Get the current coordinates of the first element in the set of matched elements, relative to the offset parent. * - * @see {@link https://api.jquery.com/position/} + * @see \`{@link https://api.jquery.com/position/ }\` * @since 1.2 */ position(): JQuery.Coordinates; @@ -4856,7 +4854,7 @@ interface JQuery extends Iterable { * * @param contents One or more additional DOM elements, text nodes, arrays of elements and text nodes, HTML strings, or * jQuery objects to insert at the beginning of each element in the set of matched elements. - * @see {@link https://api.jquery.com/prepend/} + * @see \`{@link https://api.jquery.com/prepend/ }\` * @since 1.0 */ prepend(...contents: Array>>): this; @@ -4867,7 +4865,7 @@ interface JQuery extends Iterable { * the beginning of each element in the set of matched elements. Receives the index position of the * element in the set and the old HTML value of the element as arguments. Within the function, this * refers to the current element in the set. - * @see {@link https://api.jquery.com/prepend/} + * @see \`{@link https://api.jquery.com/prepend/ }\` * @since 1.4 */ prepend(fn: (this: TElement, index: number, html: string) => JQuery.htmlString | JQuery.TypeOrArray>): this; @@ -4876,7 +4874,7 @@ interface JQuery extends Iterable { * * @param target A selector, element, HTML string, array of elements, or jQuery object; the matched set of elements * will be inserted at the beginning of the element(s) specified by this parameter. - * @see {@link https://api.jquery.com/prependTo/} + * @see \`{@link https://api.jquery.com/prependTo/ }\` * @since 1.0 */ prependTo(target: JQuery.Selector | JQuery.htmlString | JQuery.TypeOrArray | JQuery): this; @@ -4885,7 +4883,7 @@ interface JQuery extends Iterable { * is provided, it retrieves the previous sibling only if it matches that selector. * * @param selector A string containing a selector expression to match elements against. - * @see {@link https://api.jquery.com/prev/} + * @see \`{@link https://api.jquery.com/prev/ }\` * @since 1.0 */ prev(selector?: JQuery.Selector): this; @@ -4893,7 +4891,7 @@ interface JQuery extends Iterable { * Get all preceding siblings of each element in the set of matched elements, optionally filtered by a selector. * * @param selector A string containing a selector expression to match elements against. - * @see {@link https://api.jquery.com/prevAll/} + * @see \`{@link https://api.jquery.com/prevAll/ }\` * @since 1.2 */ prevAll(selector?: JQuery.Selector): this; @@ -4904,7 +4902,7 @@ interface JQuery extends Iterable { * @param selector A string containing a selector expression to indicate where to stop matching preceding sibling elements. * A DOM node or jQuery object indicating where to stop matching preceding sibling elements. * @param filter A string containing a selector expression to match elements against. - * @see {@link https://api.jquery.com/prevUntil/} + * @see \`{@link https://api.jquery.com/prevUntil/ }\` * @since 1.4 * @since 1.6 */ @@ -4915,7 +4913,7 @@ interface JQuery extends Iterable { * * @param type The type of queue that needs to be observed. * @param target Object onto which the promise methods have to be attached - * @see {@link https://api.jquery.com/promise/} + * @see \`{@link https://api.jquery.com/promise/ }\` * @since 1.6 */ promise(type: string, target: T): T & JQuery.Promise; @@ -4924,7 +4922,7 @@ interface JQuery extends Iterable { * queued or not, have finished. * * @param target Object onto which the promise methods have to be attached - * @see {@link https://api.jquery.com/promise/} + * @see \`{@link https://api.jquery.com/promise/ }\` * @since 1.6 */ promise(target: T): T & JQuery.Promise; @@ -4933,7 +4931,7 @@ interface JQuery extends Iterable { * queued or not, have finished. * * @param type The type of queue that needs to be observed. - * @see {@link https://api.jquery.com/promise/} + * @see \`{@link https://api.jquery.com/promise/ }\` * @since 1.6 */ promise(type?: string): JQuery.Promise; @@ -4943,7 +4941,7 @@ interface JQuery extends Iterable { * @param propertyName The name of the property to set. * @param value A function returning the value to set. Receives the index position of the element in the set and the * old property value as arguments. Within the function, the keyword this refers to the current element. - * @see {@link https://api.jquery.com/prop/} + * @see \`{@link https://api.jquery.com/prop/ }\` * @since 1.6 */ prop(propertyName: string, value: (this: TElement, index: number, oldPropertyValue: any) => any): this; @@ -4952,7 +4950,7 @@ interface JQuery extends Iterable { * * @param propertyName The name of the property to set. * @param value A value to set for the property. - * @see {@link https://api.jquery.com/prop/} + * @see \`{@link https://api.jquery.com/prop/ }\` * @since 1.6 */ prop(propertyName: string, value: any): this; // tslint:disable-line:unified-signatures @@ -4960,7 +4958,7 @@ interface JQuery extends Iterable { * Set one or more properties for the set of matched elements. * * @param properties An object of property-value pairs to set. - * @see {@link https://api.jquery.com/prop/} + * @see \`{@link https://api.jquery.com/prop/ }\` * @since 1.6 */ prop(properties: JQuery.PlainObject): this; @@ -4968,7 +4966,7 @@ interface JQuery extends Iterable { * Get the value of a property for the first element in the set of matched elements. * * @param propertyName The name of the property to get. - * @see {@link https://api.jquery.com/prop/} + * @see \`{@link https://api.jquery.com/prop/ }\` * @since 1.6 */ prop(propertyName: string): any | undefined; @@ -4978,7 +4976,7 @@ interface JQuery extends Iterable { * @param elements An array of elements to push onto the stack and make into a new jQuery object. * @param name The name of a jQuery method that generated the array of elements. * @param args The arguments that were passed in to the jQuery method (for serialization). - * @see {@link https://api.jquery.com/pushStack/} + * @see \`{@link https://api.jquery.com/pushStack/ }\` * @since 1.3 */ pushStack(elements: ArrayLike, name: string, args: any[]): this; @@ -4986,7 +4984,7 @@ interface JQuery extends Iterable { * Add a collection of DOM elements onto the jQuery stack. * * @param elements An array of elements to push onto the stack and make into a new jQuery object. - * @see {@link https://api.jquery.com/pushStack/} + * @see \`{@link https://api.jquery.com/pushStack/ }\` * @since 1.0 */ pushStack(elements: ArrayLike): this; @@ -4996,7 +4994,7 @@ interface JQuery extends Iterable { * @param queueName A string containing the name of the queue. Defaults to fx, the standard effects queue. * @param newQueue The new function to add to the queue, with a function to call that will dequeue the next item. * An array of functions to replace the current queue contents. - * @see {@link https://api.jquery.com/queue/} + * @see \`{@link https://api.jquery.com/queue/ }\` * @since 1.2 */ queue(queueName: string, newQueue: JQuery.TypeOrArray>): this; @@ -5005,7 +5003,7 @@ interface JQuery extends Iterable { * * @param newQueue The new function to add to the queue, with a function to call that will dequeue the next item. * An array of functions to replace the current queue contents. - * @see {@link https://api.jquery.com/queue/} + * @see \`{@link https://api.jquery.com/queue/ }\` * @since 1.2 */ queue(newQueue: JQuery.TypeOrArray>): this; @@ -5013,7 +5011,7 @@ interface JQuery extends Iterable { * Show the queue of functions to be executed on the matched elements. * * @param queueName A string containing the name of the queue. Defaults to fx, the standard effects queue. - * @see {@link https://api.jquery.com/queue/} + * @see \`{@link https://api.jquery.com/queue/ }\` * @since 1.2 */ queue(queueName?: string): JQuery.Queue; @@ -5021,7 +5019,7 @@ interface JQuery extends Iterable { * Specify a function to execute when the DOM is fully loaded. * * @param handler A function to execute after the DOM is ready. - * @see {@link https://api.jquery.com/ready/} + * @see \`{@link https://api.jquery.com/ready/ }\` * @since 1.0 * @deprecated 3.0 */ @@ -5030,7 +5028,7 @@ interface JQuery extends Iterable { * Remove the set of matched elements from the DOM. * * @param selector A selector expression that filters the set of matched elements to be removed. - * @see {@link https://api.jquery.com/remove/} + * @see \`{@link https://api.jquery.com/remove/ }\` * @since 1.0 */ remove(selector?: string): this; @@ -5038,7 +5036,7 @@ interface JQuery extends Iterable { * Remove an attribute from each element in the set of matched elements. * * @param attributeName An attribute to remove; as of version 1.7, it can be a space-separated list of attributes. - * @see {@link https://api.jquery.com/removeAttr/} + * @see \`{@link https://api.jquery.com/removeAttr/ }\` * @since 1.0 */ removeAttr(attributeName: string): this; @@ -5049,7 +5047,7 @@ interface JQuery extends Iterable { * An array of classes to be removed from the class attribute of each matched element. * A function returning one or more space-separated class names to be removed. Receives the index * position of the element in the set and the old class value as arguments. - * @see {@link https://api.jquery.com/removeClass/} + * @see \`{@link https://api.jquery.com/removeClass/ }\` * @since 1.0 * @since 1.4 * @since 3.3 @@ -5060,7 +5058,7 @@ interface JQuery extends Iterable { * * @param name A string naming the piece of data to delete. * An array or space-separated string naming the pieces of data to delete. - * @see {@link https://api.jquery.com/removeData/} + * @see \`{@link https://api.jquery.com/removeData/ }\` * @since 1.2.3 * @since 1.7 */ @@ -5069,7 +5067,7 @@ interface JQuery extends Iterable { * Remove a property for the set of matched elements. * * @param propertyName The name of the property to remove. - * @see {@link https://api.jquery.com/removeProp/} + * @see \`{@link https://api.jquery.com/removeProp/ }\` * @since 1.6 */ removeProp(propertyName: string): this; @@ -5077,7 +5075,7 @@ interface JQuery extends Iterable { * Replace each target element with the set of matched elements. * * @param target A selector string, jQuery object, DOM element, or array of elements indicating which element(s) to replace. - * @see {@link https://api.jquery.com/replaceAll/} + * @see \`{@link https://api.jquery.com/replaceAll/ }\` * @since 1.2 */ replaceAll(target: JQuery.Selector | JQuery | JQuery.TypeOrArray): this; @@ -5087,7 +5085,7 @@ interface JQuery extends Iterable { * * @param newContent The content to insert. May be an HTML string, DOM element, array of DOM elements, or jQuery object. * A function that returns content with which to replace the set of matched elements. - * @see {@link https://api.jquery.com/replaceWith/} + * @see \`{@link https://api.jquery.com/replaceWith/ }\` * @since 1.2 * @since 1.4 */ @@ -5097,7 +5095,7 @@ interface JQuery extends Iterable { * * @param eventData An object containing data that will be passed to the event handler. * @param handler A function to execute each time the event is triggered. - * @see {@link https://api.jquery.com/resize/} + * @see \`{@link https://api.jquery.com/resize/ }\` * @since 1.4.3 * @deprecated 3.3 */ @@ -5107,7 +5105,7 @@ interface JQuery extends Iterable { * Bind an event handler to the "resize" JavaScript event, or trigger that event on an element. * * @param handler A function to execute each time the event is triggered. - * @see {@link https://api.jquery.com/resize/} + * @see \`{@link https://api.jquery.com/resize/ }\` * @since 1.0 * @deprecated 3.3 */ @@ -5117,7 +5115,7 @@ interface JQuery extends Iterable { * * @param eventData An object containing data that will be passed to the event handler. * @param handler A function to execute each time the event is triggered. - * @see {@link https://api.jquery.com/scroll/} + * @see \`{@link https://api.jquery.com/scroll/ }\` * @since 1.4.3 * @deprecated 3.3 */ @@ -5127,7 +5125,7 @@ interface JQuery extends Iterable { * Bind an event handler to the "scroll" JavaScript event, or trigger that event on an element. * * @param handler A function to execute each time the event is triggered. - * @see {@link https://api.jquery.com/scroll/} + * @see \`{@link https://api.jquery.com/scroll/ }\` * @since 1.0 * @deprecated 3.3 */ @@ -5136,14 +5134,14 @@ interface JQuery extends Iterable { * Set the current horizontal position of the scroll bar for each of the set of matched elements. * * @param value An integer indicating the new position to set the scroll bar to. - * @see {@link https://api.jquery.com/scrollLeft/} + * @see \`{@link https://api.jquery.com/scrollLeft/ }\` * @since 1.2.6 */ scrollLeft(value: number): this; /** * Get the current horizontal position of the scroll bar for the first element in the set of matched elements. * - * @see {@link https://api.jquery.com/scrollLeft/} + * @see \`{@link https://api.jquery.com/scrollLeft/ }\` * @since 1.2.6 */ scrollLeft(): number | undefined; @@ -5151,7 +5149,7 @@ interface JQuery extends Iterable { * Set the current vertical position of the scroll bar for each of the set of matched elements. * * @param value A number indicating the new position to set the scroll bar to. - * @see {@link https://api.jquery.com/scrollTop/} + * @see \`{@link https://api.jquery.com/scrollTop/ }\` * @since 1.2.6 */ scrollTop(value: number): this; @@ -5159,7 +5157,7 @@ interface JQuery extends Iterable { * Get the current vertical position of the scroll bar for the first element in the set of matched * elements or set the vertical position of the scroll bar for every matched element. * - * @see {@link https://api.jquery.com/scrollTop/} + * @see \`{@link https://api.jquery.com/scrollTop/ }\` * @since 1.2.6 */ scrollTop(): number | undefined; @@ -5168,7 +5166,7 @@ interface JQuery extends Iterable { * * @param eventData An object containing data that will be passed to the event handler. * @param handler A function to execute each time the event is triggered. - * @see {@link https://api.jquery.com/select/} + * @see \`{@link https://api.jquery.com/select/ }\` * @since 1.4.3 * @deprecated 3.3 */ @@ -5178,7 +5176,7 @@ interface JQuery extends Iterable { * Bind an event handler to the "select" JavaScript event, or trigger that event on an element. * * @param handler A function to execute each time the event is triggered. - * @see {@link https://api.jquery.com/select/} + * @see \`{@link https://api.jquery.com/select/ }\` * @since 1.0 * @deprecated 3.3 */ @@ -5186,14 +5184,14 @@ interface JQuery extends Iterable { /** * Encode a set of form elements as a string for submission. * - * @see {@link https://api.jquery.com/serialize/} + * @see \`{@link https://api.jquery.com/serialize/ }\` * @since 1.0 */ serialize(): string; /** * Encode a set of form elements as an array of names and values. * - * @see {@link https://api.jquery.com/serializeArray/} + * @see \`{@link https://api.jquery.com/serializeArray/ }\` * @since 1.2 */ serializeArray(): JQuery.NameValuePair[]; @@ -5203,7 +5201,7 @@ interface JQuery extends Iterable { * @param duration A string or number determining how long the animation will run. * @param easing A string indicating which easing function to use for the transition. * @param complete A function to call once the animation is complete, called once per matched element. - * @see {@link https://api.jquery.com/show/} + * @see \`{@link https://api.jquery.com/show/ }\` * @since 1.4.3 */ show(duration: JQuery.Duration, easing: string, complete: (this: TElement) => void): this; @@ -5213,7 +5211,7 @@ interface JQuery extends Iterable { * @param duration A string or number determining how long the animation will run. * @param easing_complete A string indicating which easing function to use for the transition. * A function to call once the animation is complete, called once per matched element. - * @see {@link https://api.jquery.com/show/} + * @see \`{@link https://api.jquery.com/show/ }\` * @since 1.0 * @since 1.4.3 */ @@ -5224,7 +5222,7 @@ interface JQuery extends Iterable { * @param duration_complete_options A string or number determining how long the animation will run. * A function to call once the animation is complete, called once per matched element. * A map of additional options to pass to the method. - * @see {@link https://api.jquery.com/show/} + * @see \`{@link https://api.jquery.com/show/ }\` * @since 1.0 */ show(duration_complete_options?: JQuery.Duration | ((this: TElement) => void) | JQuery.EffectsOptions): this; @@ -5232,7 +5230,7 @@ interface JQuery extends Iterable { * Get the siblings of each element in the set of matched elements, optionally filtered by a selector. * * @param selector A string containing a selector expression to match elements against. - * @see {@link https://api.jquery.com/siblings/} + * @see \`{@link https://api.jquery.com/siblings/ }\` * @since 1.0 */ siblings(selector?: JQuery.Selector): this; @@ -5243,7 +5241,7 @@ interface JQuery extends Iterable { * it indicates an offset from the end of the set. * @param end An integer indicating the 0-based position at which the elements stop being selected. If negative, * it indicates an offset from the end of the set. If omitted, the range continues until the end of the set. - * @see {@link https://api.jquery.com/slice/} + * @see \`{@link https://api.jquery.com/slice/ }\` * @since 1.1.4 */ slice(start: number, end?: number): this; @@ -5253,7 +5251,7 @@ interface JQuery extends Iterable { * @param duration A string or number determining how long the animation will run. * @param easing A string indicating which easing function to use for the transition. * @param complete A function to call once the animation is complete, called once per matched element. - * @see {@link https://api.jquery.com/slideDown/} + * @see \`{@link https://api.jquery.com/slideDown/ }\` * @since 1.4.3 */ slideDown(duration: JQuery.Duration, easing: string, complete?: (this: TElement) => void): this; @@ -5263,7 +5261,7 @@ interface JQuery extends Iterable { * @param duration_easing A string or number determining how long the animation will run. * A string indicating which easing function to use for the transition. * @param complete A function to call once the animation is complete, called once per matched element. - * @see {@link https://api.jquery.com/slideDown/} + * @see \`{@link https://api.jquery.com/slideDown/ }\` * @since 1.0 * @since 1.4.3 */ @@ -5275,7 +5273,7 @@ interface JQuery extends Iterable { * A string indicating which easing function to use for the transition. * A function to call once the animation is complete, called once per matched element. * A map of additional options to pass to the method. - * @see {@link https://api.jquery.com/slideDown/} + * @see \`{@link https://api.jquery.com/slideDown/ }\` * @since 1.0 * @since 1.4.3 */ @@ -5286,7 +5284,7 @@ interface JQuery extends Iterable { * @param duration A string or number determining how long the animation will run. * @param easing A string indicating which easing function to use for the transition. * @param complete A function to call once the animation is complete, called once per matched element. - * @see {@link https://api.jquery.com/slideToggle/} + * @see \`{@link https://api.jquery.com/slideToggle/ }\` * @since 1.4.3 */ slideToggle(duration: JQuery.Duration, easing: string, complete?: (this: TElement) => void): this; @@ -5296,7 +5294,7 @@ interface JQuery extends Iterable { * @param duration_easing A string or number determining how long the animation will run. * A string indicating which easing function to use for the transition. * @param complete A function to call once the animation is complete, called once per matched element. - * @see {@link https://api.jquery.com/slideToggle/} + * @see \`{@link https://api.jquery.com/slideToggle/ }\` * @since 1.0 * @since 1.4.3 */ @@ -5308,7 +5306,7 @@ interface JQuery extends Iterable { * A string indicating which easing function to use for the transition. * A function to call once the animation is complete, called once per matched element. * A map of additional options to pass to the method. - * @see {@link https://api.jquery.com/slideToggle/} + * @see \`{@link https://api.jquery.com/slideToggle/ }\` * @since 1.0 * @since 1.4.3 */ @@ -5319,7 +5317,7 @@ interface JQuery extends Iterable { * @param duration A string or number determining how long the animation will run. * @param easing A string indicating which easing function to use for the transition. * @param complete A function to call once the animation is complete, called once per matched element. - * @see {@link https://api.jquery.com/slideUp/} + * @see \`{@link https://api.jquery.com/slideUp/ }\` * @since 1.4.3 */ slideUp(duration: JQuery.Duration, easing: string, complete?: (this: TElement) => void): this; @@ -5329,7 +5327,7 @@ interface JQuery extends Iterable { * @param duration_easing A string or number determining how long the animation will run. * A string indicating which easing function to use for the transition. * @param complete A function to call once the animation is complete, called once per matched element. - * @see {@link https://api.jquery.com/slideUp/} + * @see \`{@link https://api.jquery.com/slideUp/ }\` * @since 1.0 * @since 1.4.3 */ @@ -5341,7 +5339,7 @@ interface JQuery extends Iterable { * A string indicating which easing function to use for the transition. * A function to call once the animation is complete, called once per matched element. * A map of additional options to pass to the method. - * @see {@link https://api.jquery.com/slideUp/} + * @see \`{@link https://api.jquery.com/slideUp/ }\` * @since 1.0 * @since 1.4.3 */ @@ -5352,7 +5350,7 @@ interface JQuery extends Iterable { * @param queue The name of the queue in which to stop animations. * @param clearQueue A Boolean indicating whether to remove queued animation as well. Defaults to false. * @param jumpToEnd A Boolean indicating whether to complete the current animation immediately. Defaults to false. - * @see {@link https://api.jquery.com/stop/} + * @see \`{@link https://api.jquery.com/stop/ }\` * @since 1.7 */ stop(queue: string, clearQueue?: boolean, jumpToEnd?: boolean): this; @@ -5361,7 +5359,7 @@ interface JQuery extends Iterable { * * @param clearQueue A Boolean indicating whether to remove queued animation as well. Defaults to false. * @param jumpToEnd A Boolean indicating whether to complete the current animation immediately. Defaults to false. - * @see {@link https://api.jquery.com/stop/} + * @see \`{@link https://api.jquery.com/stop/ }\` * @since 1.2 */ stop(clearQueue?: boolean, jumpToEnd?: boolean): this; @@ -5370,7 +5368,7 @@ interface JQuery extends Iterable { * * @param eventData An object containing data that will be passed to the event handler. * @param handler A function to execute each time the event is triggered. - * @see {@link https://api.jquery.com/submit/} + * @see \`{@link https://api.jquery.com/submit/ }\` * @since 1.4.3 * @deprecated 3.3 */ @@ -5380,7 +5378,7 @@ interface JQuery extends Iterable { * Bind an event handler to the "submit" JavaScript event, or trigger that event on an element. * * @param handler A function to execute each time the event is triggered. - * @see {@link https://api.jquery.com/submit/} + * @see \`{@link https://api.jquery.com/submit/ }\` * @since 1.0 * @deprecated 3.3 */ @@ -5392,7 +5390,7 @@ interface JQuery extends Iterable { * be converted to a String representation. * A function returning the text content to set. Receives the index position of the element in the set * and the old text value as arguments. - * @see {@link https://api.jquery.com/text/} + * @see \`{@link https://api.jquery.com/text/ }\` * @since 1.0 * @since 1.4 */ @@ -5400,14 +5398,14 @@ interface JQuery extends Iterable { /** * Get the combined text contents of each element in the set of matched elements, including their descendants. * - * @see {@link https://api.jquery.com/text/} + * @see \`{@link https://api.jquery.com/text/ }\` * @since 1.0 */ text(): string; /** * Retrieve all the elements contained in the jQuery set, as an array. * - * @see {@link https://api.jquery.com/toArray/} + * @see \`{@link https://api.jquery.com/toArray/ }\` * @since 1.4 */ toArray(): TElement[]; @@ -5417,7 +5415,7 @@ interface JQuery extends Iterable { * @param duration A string or number determining how long the animation will run. * @param easing A string indicating which easing function to use for the transition. * @param complete A function to call once the animation is complete, called once per matched element. - * @see {@link https://api.jquery.com/toggle/} + * @see \`{@link https://api.jquery.com/toggle/ }\` * @since 1.4.3 */ toggle(duration: JQuery.Duration, easing: string, complete?: (this: TElement) => void): this; @@ -5426,7 +5424,7 @@ interface JQuery extends Iterable { * * @param duration A string or number determining how long the animation will run. * @param complete A function to call once the animation is complete, called once per matched element. - * @see {@link https://api.jquery.com/toggle/} + * @see \`{@link https://api.jquery.com/toggle/ }\` * @since 1.0 */ toggle(duration: JQuery.Duration, complete: (this: TElement) => void): this; @@ -5437,7 +5435,7 @@ interface JQuery extends Iterable { * A function to call once the animation is complete, called once per matched element. * A map of additional options to pass to the method. * Use true to show the element or false to hide it. - * @see {@link https://api.jquery.com/toggle/} + * @see \`{@link https://api.jquery.com/toggle/ }\` * @since 1.0 * @since 1.3 */ @@ -5451,7 +5449,7 @@ interface JQuery extends Iterable { * A function that returns class names to be toggled in the class attribute of each element in the * matched set. Receives the index position of the element in the set, the old class value, and the state as arguments. * @param state A Boolean (not just truthy/falsy) value to determine whether the class should be added or removed. - * @see {@link https://api.jquery.com/toggleClass/} + * @see \`{@link https://api.jquery.com/toggleClass/ }\` * @since 1.0 * @since 1.3 * @since 1.4 @@ -5464,7 +5462,7 @@ interface JQuery extends Iterable { * either the class's presence or the value of the state argument. * * @param state A boolean value to determine whether the class should be added or removed. - * @see {@link https://api.jquery.com/toggleClass/} + * @see \`{@link https://api.jquery.com/toggleClass/ }\` * @since 1.4 * @deprecated 3.0 */ @@ -5475,7 +5473,7 @@ interface JQuery extends Iterable { * @param eventType A string containing a JavaScript event type, such as click or submit. * A jQuery.Event object. * @param extraParameters Additional parameters to pass along to the event handler. - * @see {@link https://api.jquery.com/trigger/} + * @see \`{@link https://api.jquery.com/trigger/ }\` * @since 1.0 * @since 1.3 */ @@ -5486,7 +5484,7 @@ interface JQuery extends Iterable { * @param eventType A string containing a JavaScript event type, such as click or submit. * A jQuery.Event object. * @param extraParameters Additional parameters to pass along to the event handler. - * @see {@link https://api.jquery.com/triggerHandler/} + * @see \`{@link https://api.jquery.com/triggerHandler/ }\` * @since 1.2 * @since 1.3 */ @@ -5496,7 +5494,7 @@ interface JQuery extends Iterable { * * @param event A string containing one or more DOM event types, such as "click" or "submit," or custom event names. * @param handler A function to execute each time the event is triggered. - * @see {@link https://api.jquery.com/unbind/} + * @see \`{@link https://api.jquery.com/unbind/ }\` * @since 1.0 * @since 1.4.3 * @deprecated 3.0 @@ -5507,7 +5505,7 @@ interface JQuery extends Iterable { * * @param event A string containing one or more DOM event types, such as "click" or "submit," or custom event names. * A jQuery.Event object. - * @see {@link https://api.jquery.com/unbind/} + * @see \`{@link https://api.jquery.com/unbind/ }\` * @since 1.0 * @deprecated 3.0 */ @@ -5519,7 +5517,7 @@ interface JQuery extends Iterable { * @param selector A selector which will be used to filter the event results. * @param eventType A string containing a JavaScript event type, such as "click" or "keydown" * @param handler A function to execute each time the event is triggered. - * @see {@link https://api.jquery.com/undelegate/} + * @see \`{@link https://api.jquery.com/undelegate/ }\` * @since 1.4.2 * @deprecated 3.0 */ @@ -5531,7 +5529,7 @@ interface JQuery extends Iterable { * @param selector A selector which will be used to filter the event results. * @param eventTypes A string containing a JavaScript event type, such as "click" or "keydown" * An object of one or more event types and previously bound functions to unbind from them. - * @see {@link https://api.jquery.com/undelegate/} + * @see \`{@link https://api.jquery.com/undelegate/ }\` * @since 1.4.2 * @since 1.4.3 * @deprecated 3.0 @@ -5542,7 +5540,7 @@ interface JQuery extends Iterable { * specific set of root elements. * * @param namespace A selector which will be used to filter the event results. - * @see {@link https://api.jquery.com/undelegate/} + * @see \`{@link https://api.jquery.com/undelegate/ }\` * @since 1.4.2 * @since 1.6 * @deprecated 3.0 @@ -5553,7 +5551,7 @@ interface JQuery extends Iterable { * * @param selector A selector to check the parent element against. If an element's parent does not match the selector, * the element won't be unwrapped. - * @see {@link https://api.jquery.com/unwrap/} + * @see \`{@link https://api.jquery.com/unwrap/ }\` * @since 1.4 * @since 3.0 */ @@ -5565,7 +5563,7 @@ interface JQuery extends Iterable { * element to set as selected/checked. * A function returning the value to set. this is the current element. Receives the index position of * the element in the set and the old value as arguments. - * @see {@link https://api.jquery.com/val/} + * @see \`{@link https://api.jquery.com/val/ }\` * @since 1.0 * @since 1.4 */ @@ -5573,7 +5571,7 @@ interface JQuery extends Iterable { /** * Get the current value of the first element in the set of matched elements. * - * @see {@link https://api.jquery.com/val/} + * @see \`{@link https://api.jquery.com/val/ }\` * @since 1.0 */ val(): string | number | string[] | undefined; @@ -5584,7 +5582,7 @@ interface JQuery extends Iterable { * appended (as a string). * A function returning the width to set. Receives the index position of the element in the set and the * old width as arguments. Within the function, this refers to the current element in the set. - * @see {@link https://api.jquery.com/width/} + * @see \`{@link https://api.jquery.com/width/ }\` * @since 1.0 * @since 1.4.1 */ @@ -5592,7 +5590,7 @@ interface JQuery extends Iterable { /** * Get the current computed width for the first element in the set of matched elements. * - * @see {@link https://api.jquery.com/width/} + * @see \`{@link https://api.jquery.com/width/ }\` * @since 1.0 */ width(): number | undefined; @@ -5605,7 +5603,7 @@ interface JQuery extends Iterable { * A callback function returning the HTML content or jQuery object to wrap around the matched elements. * Receives the index position of the element in the set as an argument. Within the function, this * refers to the current element in the set. - * @see {@link https://api.jquery.com/wrap/} + * @see \`{@link https://api.jquery.com/wrap/ }\` * @since 1.0 * @since 1.4 */ @@ -5618,7 +5616,7 @@ interface JQuery extends Iterable { * elements. Within the function, this refers to the first element in the set. Prior to jQuery 3.0, the * callback was incorrectly called for every element in the set and received the index position of the * element in the set as an argument. - * @see {@link https://api.jquery.com/wrapAll/} + * @see \`{@link https://api.jquery.com/wrapAll/ }\` * @since 1.2 * @since 1.4 */ @@ -5631,7 +5629,7 @@ interface JQuery extends Iterable { * A callback function which generates a structure to wrap around the content of the matched elements. * Receives the index position of the element in the set as an argument. Within the function, this * refers to the current element in the set. - * @see {@link https://api.jquery.com/wrapInner/} + * @see \`{@link https://api.jquery.com/wrapInner/ }\` * @since 1.2 * @since 1.4 */ @@ -5721,7 +5719,7 @@ declare namespace JQuery { } /** - * @see {@link http://api.jquery.com/jquery.ajax/#jQuery-ajax-settings} + * @see \`{@link http://api.jquery.com/jquery.ajax/#jQuery-ajax-settings }\` */ interface AjaxSettingsBase { /** @@ -6410,7 +6408,7 @@ declare namespace JQuery { } /** - * @see {@link http://api.jquery.com/jquery.ajax/#jqXHR} + * @see \`{@link http://api.jquery.com/jquery.ajax/#jqXHR }\` */ interface jqXHR extends Promise3, never, Ajax.SuccessTextStatus, Ajax.ErrorTextStatus, never, @@ -6423,7 +6421,7 @@ declare namespace JQuery { /** * Determine the current state of a Deferred object. * - * @see {@link https://api.jquery.com/deferred.state/} + * @see \`{@link https://api.jquery.com/deferred.state/ }\` * @since 1.7 */ state(): 'pending' | 'resolved' | 'rejected'; @@ -6457,28 +6455,28 @@ declare namespace JQuery { * * @param callback A function, or array of functions, that are to be added to the callback list. * @param callbacks A function, or array of functions, that are to be added to the callback list. - * @see {@link https://api.jquery.com/callbacks.add/} + * @see \`{@link https://api.jquery.com/callbacks.add/ }\` * @since 1.7 */ add(callback: TypeOrArray, ...callbacks: Array>): this; /** * Disable a callback list from doing anything more. * - * @see {@link https://api.jquery.com/callbacks.disable/} + * @see \`{@link https://api.jquery.com/callbacks.disable/ }\` * @since 1.7 */ disable(): this; /** * Determine if the callbacks list has been disabled. * - * @see {@link https://api.jquery.com/callbacks.disabled/} + * @see \`{@link https://api.jquery.com/callbacks.disabled/ }\` * @since 1.7 */ disabled(): boolean; /** * Remove all of the callbacks from a list. * - * @see {@link https://api.jquery.com/callbacks.empty/} + * @see \`{@link https://api.jquery.com/callbacks.empty/ }\` * @since 1.7 */ empty(): this; @@ -6486,7 +6484,7 @@ declare namespace JQuery { * Call all of the callbacks with the given arguments. * * @param args The argument or list of arguments to pass back to the callback list. - * @see {@link https://api.jquery.com/callbacks.fire/} + * @see \`{@link https://api.jquery.com/callbacks.fire/ }\` * @since 1.7 */ fire(...args: any[]): this; @@ -6495,14 +6493,14 @@ declare namespace JQuery { * * @param context A reference to the context in which the callbacks in the list should be fired. * @param args An argument, or array of arguments, to pass to the callbacks in the list. - * @see {@link https://api.jquery.com/callbacks.fireWith/} + * @see \`{@link https://api.jquery.com/callbacks.fireWith/ }\` * @since 1.7 */ fireWith(context: object, args?: ArrayLike): this; /** * Determine if the callbacks have already been called at least once. * - * @see {@link https://api.jquery.com/callbacks.fired/} + * @see \`{@link https://api.jquery.com/callbacks.fired/ }\` * @since 1.7 */ fired(): boolean; @@ -6511,21 +6509,21 @@ declare namespace JQuery { * argument, determine whether it is in a list. * * @param callback The callback to search for. - * @see {@link https://api.jquery.com/callbacks.has/} + * @see \`{@link https://api.jquery.com/callbacks.has/ }\` * @since 1.7 */ has(callback?: T): boolean; /** * Lock a callback list in its current state. * - * @see {@link https://api.jquery.com/callbacks.lock/} + * @see \`{@link https://api.jquery.com/callbacks.lock/ }\` * @since 1.7 */ lock(): this; /** * Determine if the callbacks list has been locked. * - * @see {@link https://api.jquery.com/callbacks.locked/} + * @see \`{@link https://api.jquery.com/callbacks.locked/ }\` * @since 1.7 */ locked(): boolean; @@ -6533,7 +6531,7 @@ declare namespace JQuery { * Remove a callback or a collection of callbacks from a callback list. * * @param callbacks A function, or array of functions, that are to be removed from the callback list. - * @see {@link https://api.jquery.com/callbacks.remove/} + * @see \`{@link https://api.jquery.com/callbacks.remove/ }\` * @since 1.7 */ remove(...callbacks: T[]): this; @@ -6557,6 +6555,28 @@ declare namespace JQuery { */ interface Thenable extends PromiseLike { } + // NOTE: This is a private copy of the global Promise interface. It is used by JQuery.PromiseBase to indicate compatibility with other Promise implementations. + // The global Promise interface cannot be used directly as it may be modified, as in the case of @types/bluebird-global. + /** + * Represents the completion of an asynchronous operation + */ + interface _Promise { + /** + * Attaches callbacks for the resolution and/or rejection of the Promise. + * @param onfulfilled The callback to execute when the Promise is resolved. + * @param onrejected The callback to execute when the Promise is rejected. + * @returns A Promise for the completion of which ever callback is executed. + */ + then(onfulfilled?: ((value: T) => TResult1 | PromiseLike) | null, + onrejected?: ((reason: any) => TResult2 | PromiseLike) | null): JQuery._Promise; + /** + * Attaches a callback for only the rejection of the Promise. + * @param onrejected The callback to execute when the Promise is rejected. + * @returns A Promise for the completion of the callback. + */ + catch(onrejected?: ((reason: any) => TResult | PromiseLike) | null): JQuery._Promise; + } + // Type parameter guide // -------------------- // Each type parameter represents a parameter in one of the three possible callbacks. @@ -6576,19 +6596,19 @@ declare namespace JQuery { * This object provides a subset of the methods of the Deferred object (then, done, fail, always, * pipe, progress, state and promise) to prevent users from changing the state of the Deferred. * - * @see {@link http://api.jquery.com/Types/#Promise} + * @see \`{@link http://api.jquery.com/Types/#Promise }\` * @deprecated Experimental. Avoid referncing this type directly in your code. */ interface PromiseBase extends _Promise, PromiseLike { + SR, SJ, SN> extends JQuery._Promise, PromiseLike { /** * Add handlers to be called when the Deferred object is either resolved or rejected. * * @param alwaysCallback A function, or array of functions, that is called when the Deferred is resolved or rejected. * @param alwaysCallbacks Optional additional functions, or arrays of functions, that are called when the Deferred is resolved or rejected. - * @see {@link https://api.jquery.com/deferred.always/} + * @see \`{@link https://api.jquery.com/deferred.always/ }\` * @since 1.6 */ always(alwaysCallback: TypeOrArray>, @@ -6598,7 +6618,7 @@ declare namespace JQuery { * * @param doneCallback A function, or array of functions, that are called when the Deferred is resolved. * @param doneCallbacks Optional additional functions, or arrays of functions, that are called when the Deferred is resolved. - * @see {@link https://api.jquery.com/deferred.done/} + * @see \`{@link https://api.jquery.com/deferred.done/ }\` * @since 1.5 */ done(doneCallback: TypeOrArray>, @@ -6608,7 +6628,7 @@ declare namespace JQuery { * * @param failCallback A function, or array of functions, that are called when the Deferred is rejected. * @param failCallbacks Optional additional functions, or arrays of functions, that are called when the Deferred is rejected. - * @see {@link https://api.jquery.com/deferred.fail/} + * @see \`{@link https://api.jquery.com/deferred.fail/ }\` * @since 1.5 */ fail(failCallback: TypeOrArray>, @@ -6619,7 +6639,7 @@ declare namespace JQuery { * @param progressCallback A function, or array of functions, to be called when the Deferred generates progress notifications. * @param progressCallbacks Optional additional functions, or arrays of functions, to be called when the Deferred generates * progress notifications. - * @see {@link https://api.jquery.com/deferred.progress/} + * @see \`{@link https://api.jquery.com/deferred.progress/ }\` * @since 1.7 */ progress(progressCallback: TypeOrArray>, @@ -6628,21 +6648,21 @@ declare namespace JQuery { * Return a Deferred's Promise object. * * @param target Object onto which the promise methods have to be attached - * @see {@link https://api.jquery.com/deferred.promise/} + * @see \`{@link https://api.jquery.com/deferred.promise/ }\` * @since 1.5 */ promise(target: TTarget): this & TTarget; /** * Return a Deferred's Promise object. * - * @see {@link https://api.jquery.com/deferred.promise/} + * @see \`{@link https://api.jquery.com/deferred.promise/ }\` * @since 1.5 */ promise(): this; /** * Determine the current state of a Deferred object. * - * @see {@link https://api.jquery.com/deferred.state/} + * @see \`{@link https://api.jquery.com/deferred.state/ }\` * @since 1.7 */ state(): 'pending' | 'resolved' | 'rejected'; @@ -6655,7 +6675,7 @@ declare namespace JQuery { * @param doneFilter An optional function that is called when the Deferred is resolved. * @param failFilter An optional function that is called when the Deferred is rejected. * @param progressFilter An optional function that is called when progress notifications are sent to the Deferred. - * @see {@link https://api.jquery.com/deferred.pipe/} + * @see \`{@link https://api.jquery.com/deferred.pipe/ }\` * @since 1.6 * @since 1.7 * @deprecated 1.8 @@ -6693,7 +6713,7 @@ declare namespace JQuery { * @param doneFilter An optional function that is called when the Deferred is resolved. * @param failFilter An optional function that is called when the Deferred is rejected. * @param progressFilter An optional function that is called when progress notifications are sent to the Deferred. - * @see {@link https://api.jquery.com/deferred.pipe/} + * @see \`{@link https://api.jquery.com/deferred.pipe/ }\` * @since 1.6 * @since 1.7 * @deprecated 1.8 @@ -6724,7 +6744,7 @@ declare namespace JQuery { * @param doneFilter An optional function that is called when the Deferred is resolved. * @param failFilter An optional function that is called when the Deferred is rejected. * @param progressFilter An optional function that is called when progress notifications are sent to the Deferred. - * @see {@link https://api.jquery.com/deferred.pipe/} + * @see \`{@link https://api.jquery.com/deferred.pipe/ }\` * @since 1.6 * @since 1.7 * @deprecated 1.8 @@ -6755,7 +6775,7 @@ declare namespace JQuery { * @param doneFilter An optional function that is called when the Deferred is resolved. * @param failFilter An optional function that is called when the Deferred is rejected. * @param progressFilter An optional function that is called when progress notifications are sent to the Deferred. - * @see {@link https://api.jquery.com/deferred.pipe/} + * @see \`{@link https://api.jquery.com/deferred.pipe/ }\` * @since 1.6 * @since 1.7 * @deprecated 1.8 @@ -6779,7 +6799,7 @@ declare namespace JQuery { * @param doneFilter An optional function that is called when the Deferred is resolved. * @param failFilter An optional function that is called when the Deferred is rejected. * @param progressFilter An optional function that is called when progress notifications are sent to the Deferred. - * @see {@link https://api.jquery.com/deferred.pipe/} + * @see \`{@link https://api.jquery.com/deferred.pipe/ }\` * @since 1.6 * @since 1.7 * @deprecated 1.8 @@ -6810,7 +6830,7 @@ declare namespace JQuery { * @param doneFilter An optional function that is called when the Deferred is resolved. * @param failFilter An optional function that is called when the Deferred is rejected. * @param progressFilter An optional function that is called when progress notifications are sent to the Deferred. - * @see {@link https://api.jquery.com/deferred.pipe/} + * @see \`{@link https://api.jquery.com/deferred.pipe/ }\` * @since 1.6 * @since 1.7 * @deprecated 1.8 @@ -6834,7 +6854,7 @@ declare namespace JQuery { * @param doneFilter An optional function that is called when the Deferred is resolved. * @param failFilter An optional function that is called when the Deferred is rejected. * @param progressFilter An optional function that is called when progress notifications are sent to the Deferred. - * @see {@link https://api.jquery.com/deferred.pipe/} + * @see \`{@link https://api.jquery.com/deferred.pipe/ }\` * @since 1.6 * @since 1.7 * @deprecated 1.8 @@ -6863,7 +6883,7 @@ declare namespace JQuery { * @param doneFilter An optional function that is called when the Deferred is resolved. * @param failFilter An optional function that is called when the Deferred is rejected. * @param progressFilter An optional function that is called when progress notifications are sent to the Deferred. - * @see {@link https://api.jquery.com/deferred.then/} + * @see \`{@link https://api.jquery.com/deferred.then/ }\` * @since 1.8 */ then extends PromiseBase extends PromiseBase): this; @@ -7133,7 +7153,7 @@ declare namespace JQuery { * Reject a Deferred object and call any failCallbacks with the given args. * * @param args Optional arguments that are passed to the failCallbacks. - * @see {@link https://api.jquery.com/deferred.reject/} + * @see \`{@link https://api.jquery.com/deferred.reject/ }\` * @since 1.5 */ reject(...args: TJ[]): this; @@ -7142,7 +7162,7 @@ declare namespace JQuery { * * @param context Context passed to the failCallbacks as the this object. * @param args An optional array of arguments that are passed to the failCallbacks. - * @see {@link https://api.jquery.com/deferred.rejectWith/} + * @see \`{@link https://api.jquery.com/deferred.rejectWith/ }\` * @since 1.5 */ rejectWith(context: object, args?: ArrayLike): this; @@ -7150,7 +7170,7 @@ declare namespace JQuery { * Resolve a Deferred object and call any doneCallbacks with the given args. * * @param args Optional arguments that are passed to the doneCallbacks. - * @see {@link https://api.jquery.com/deferred.resolve/} + * @see \`{@link https://api.jquery.com/deferred.resolve/ }\` * @since 1.5 */ resolve(...args: TR[]): this; @@ -7159,7 +7179,7 @@ declare namespace JQuery { * * @param context Context passed to the doneCallbacks as the this object. * @param args An optional array of arguments that are passed to the doneCallbacks. - * @see {@link https://api.jquery.com/deferred.resolveWith/} + * @see \`{@link https://api.jquery.com/deferred.resolveWith/ }\` * @since 1.5 */ resolveWith(context: object, args?: ArrayLike): this; @@ -7169,7 +7189,7 @@ declare namespace JQuery { * * @param alwaysCallback A function, or array of functions, that is called when the Deferred is resolved or rejected. * @param alwaysCallbacks Optional additional functions, or arrays of functions, that are called when the Deferred is resolved or rejected. - * @see {@link https://api.jquery.com/deferred.always/} + * @see \`{@link https://api.jquery.com/deferred.always/ }\` * @since 1.6 */ always(alwaysCallback: TypeOrArray>, @@ -7179,7 +7199,7 @@ declare namespace JQuery { * * @param doneCallback A function, or array of functions, that are called when the Deferred is resolved. * @param doneCallbacks Optional additional functions, or arrays of functions, that are called when the Deferred is resolved. - * @see {@link https://api.jquery.com/deferred.done/} + * @see \`{@link https://api.jquery.com/deferred.done/ }\` * @since 1.5 */ done(doneCallback: TypeOrArray>, @@ -7189,7 +7209,7 @@ declare namespace JQuery { * * @param failCallback A function, or array of functions, that are called when the Deferred is rejected. * @param failCallbacks Optional additional functions, or arrays of functions, that are called when the Deferred is rejected. - * @see {@link https://api.jquery.com/deferred.fail/} + * @see \`{@link https://api.jquery.com/deferred.fail/ }\` * @since 1.5 */ fail(failCallback: TypeOrArray>, @@ -7200,7 +7220,7 @@ declare namespace JQuery { * @param progressCallback A function, or array of functions, to be called when the Deferred generates progress notifications. * @param progressCallbacks Optional additional functions, or arrays of functions, to be called when the Deferred generates * progress notifications. - * @see {@link https://api.jquery.com/deferred.progress/} + * @see \`{@link https://api.jquery.com/deferred.progress/ }\` * @since 1.7 */ progress(progressCallback: TypeOrArray>, @@ -7209,21 +7229,21 @@ declare namespace JQuery { * Return a Deferred's Promise object. * * @param target Object onto which the promise methods have to be attached - * @see {@link https://api.jquery.com/deferred.promise/} + * @see \`{@link https://api.jquery.com/deferred.promise/ }\` * @since 1.5 */ promise(target: TTarget): JQuery.Promise & TTarget; /** * Return a Deferred's Promise object. * - * @see {@link https://api.jquery.com/deferred.promise/} + * @see \`{@link https://api.jquery.com/deferred.promise/ }\` * @since 1.5 */ promise(): JQuery.Promise; /** * Determine the current state of a Deferred object. * - * @see {@link https://api.jquery.com/deferred.state/} + * @see \`{@link https://api.jquery.com/deferred.state/ }\` * @since 1.7 */ state(): 'pending' | 'resolved' | 'rejected'; @@ -7236,7 +7256,7 @@ declare namespace JQuery { * @param doneFilter An optional function that is called when the Deferred is resolved. * @param failFilter An optional function that is called when the Deferred is rejected. * @param progressFilter An optional function that is called when progress notifications are sent to the Deferred. - * @see {@link https://api.jquery.com/deferred.pipe/} + * @see \`{@link https://api.jquery.com/deferred.pipe/ }\` * @since 1.6 * @since 1.7 * @deprecated 1.8 @@ -7274,7 +7294,7 @@ declare namespace JQuery { * @param doneFilter An optional function that is called when the Deferred is resolved. * @param failFilter An optional function that is called when the Deferred is rejected. * @param progressFilter An optional function that is called when progress notifications are sent to the Deferred. - * @see {@link https://api.jquery.com/deferred.pipe/} + * @see \`{@link https://api.jquery.com/deferred.pipe/ }\` * @since 1.6 * @since 1.7 * @deprecated 1.8 @@ -7305,7 +7325,7 @@ declare namespace JQuery { * @param doneFilter An optional function that is called when the Deferred is resolved. * @param failFilter An optional function that is called when the Deferred is rejected. * @param progressFilter An optional function that is called when progress notifications are sent to the Deferred. - * @see {@link https://api.jquery.com/deferred.pipe/} + * @see \`{@link https://api.jquery.com/deferred.pipe/ }\` * @since 1.6 * @since 1.7 * @deprecated 1.8 @@ -7336,7 +7356,7 @@ declare namespace JQuery { * @param doneFilter An optional function that is called when the Deferred is resolved. * @param failFilter An optional function that is called when the Deferred is rejected. * @param progressFilter An optional function that is called when progress notifications are sent to the Deferred. - * @see {@link https://api.jquery.com/deferred.pipe/} + * @see \`{@link https://api.jquery.com/deferred.pipe/ }\` * @since 1.6 * @since 1.7 * @deprecated 1.8 @@ -7360,7 +7380,7 @@ declare namespace JQuery { * @param doneFilter An optional function that is called when the Deferred is resolved. * @param failFilter An optional function that is called when the Deferred is rejected. * @param progressFilter An optional function that is called when progress notifications are sent to the Deferred. - * @see {@link https://api.jquery.com/deferred.pipe/} + * @see \`{@link https://api.jquery.com/deferred.pipe/ }\` * @since 1.6 * @since 1.7 * @deprecated 1.8 @@ -7391,7 +7411,7 @@ declare namespace JQuery { * @param doneFilter An optional function that is called when the Deferred is resolved. * @param failFilter An optional function that is called when the Deferred is rejected. * @param progressFilter An optional function that is called when progress notifications are sent to the Deferred. - * @see {@link https://api.jquery.com/deferred.pipe/} + * @see \`{@link https://api.jquery.com/deferred.pipe/ }\` * @since 1.6 * @since 1.7 * @deprecated 1.8 @@ -7415,7 +7435,7 @@ declare namespace JQuery { * @param doneFilter An optional function that is called when the Deferred is resolved. * @param failFilter An optional function that is called when the Deferred is rejected. * @param progressFilter An optional function that is called when progress notifications are sent to the Deferred. - * @see {@link https://api.jquery.com/deferred.pipe/} + * @see \`{@link https://api.jquery.com/deferred.pipe/ }\` * @since 1.6 * @since 1.7 * @deprecated 1.8 @@ -7444,7 +7464,7 @@ declare namespace JQuery { * @param doneFilter A function that is called when the Deferred is resolved. * @param failFilter An optional function that is called when the Deferred is rejected. * @param progressFilter An optional function that is called when progress notifications are sent to the Deferred. - * @see {@link https://api.jquery.com/deferred.then/} + * @see \`{@link https://api.jquery.com/deferred.then/ }\` * @since 1.8 */ then { /** @@ -7807,98 +7827,98 @@ declare namespace JQuery { /** * Indicates whether the META key was pressed when the event fired. * - * @see {@link https://api.jquery.com/event.metaKey/} + * @see \`{@link https://api.jquery.com/event.metaKey/ }\` * @since 1.0.4 */ metaKey: boolean; /** * The namespace specified when the event was triggered. * - * @see {@link https://api.jquery.com/event.namespace/} + * @see \`{@link https://api.jquery.com/event.namespace/ }\` * @since 1.4.3 */ namespace: string; /** * The mouse position relative to the left edge of the document. * - * @see {@link https://api.jquery.com/event.pageX/} + * @see \`{@link https://api.jquery.com/event.pageX/ }\` * @since 1.0.4 */ pageX: number; /** * The mouse position relative to the top edge of the document. * - * @see {@link https://api.jquery.com/event.pageY/} + * @see \`{@link https://api.jquery.com/event.pageY/ }\` * @since 1.0.4 */ pageY: number; /** * The last value returned by an event handler that was triggered by this event, unless the value was undefined. * - * @see {@link https://api.jquery.com/event.result/} + * @see \`{@link https://api.jquery.com/event.result/ }\` * @since 1.3 */ result: any; /** * The difference in milliseconds between the time the browser created the event and January 1, 1970. * - * @see {@link https://api.jquery.com/event.timeStamp/} + * @see \`{@link https://api.jquery.com/event.timeStamp/ }\` * @since 1.2.6 */ timeStamp: number; /** * Describes the nature of the event. * - * @see {@link https://api.jquery.com/event.type/} + * @see \`{@link https://api.jquery.com/event.type/ }\` * @since 1.0 */ type: string; /** * For key or mouse events, this property indicates the specific key or button that was pressed. * - * @see {@link https://api.jquery.com/event.which/} + * @see \`{@link https://api.jquery.com/event.which/ }\` * @since 1.1.3 */ which: number; /** * Returns whether event.preventDefault() was ever called on this event object. * - * @see {@link https://api.jquery.com/event.isDefaultPrevented/} + * @see \`{@link https://api.jquery.com/event.isDefaultPrevented/ }\` * @since 1.3 */ isDefaultPrevented(): boolean; /** * Returns whether event.stopImmediatePropagation() was ever called on this event object. * - * @see {@link https://api.jquery.com/event.isImmediatePropagationStopped/} + * @see \`{@link https://api.jquery.com/event.isImmediatePropagationStopped/ }\` * @since 1.3 */ isImmediatePropagationStopped(): boolean; /** * Returns whether event.stopPropagation() was ever called on this event object. * - * @see {@link https://api.jquery.com/event.isPropagationStopped/} + * @see \`{@link https://api.jquery.com/event.isPropagationStopped/ }\` * @since 1.3 */ isPropagationStopped(): boolean; /** * If this method is called, the default action of the event will not be triggered. * - * @see {@link https://api.jquery.com/event.preventDefault/} + * @see \`{@link https://api.jquery.com/event.preventDefault/ }\` * @since 1.0 */ preventDefault(): void; /** * Keeps the rest of the handlers from being executed and prevents the event from bubbling up the DOM tree. * - * @see {@link https://api.jquery.com/event.stopImmediatePropagation/} + * @see \`{@link https://api.jquery.com/event.stopImmediatePropagation/ }\` * @since 1.3 */ stopImmediatePropagation(): void; /** * Prevents the event from bubbling up the DOM tree, preventing any parent handlers from being notified of the event. * - * @see {@link https://api.jquery.com/event.stopPropagation/} + * @see \`{@link https://api.jquery.com/event.stopPropagation/ }\` * @since 1.0 */ stopPropagation(): void; @@ -7913,21 +7933,21 @@ declare namespace JQuery { /** * The current DOM element within the event bubbling phase. * - * @see {@link https://api.jquery.com/event.currentTarget/} + * @see \`{@link https://api.jquery.com/event.currentTarget/ }\` * @since 1.3 */ currentTarget: TTarget; /** * An optional object of data passed to an event method when the current executing handler is bound. * - * @see {@link https://api.jquery.com/event.data/} + * @see \`{@link https://api.jquery.com/event.data/ }\` * @since 1.1 */ data: TData; /** * The element where the currently-called jQuery event handler was attached. * - * @see {@link https://api.jquery.com/event.delegateTarget/} + * @see \`{@link https://api.jquery.com/event.delegateTarget/ }\` * @since 1.7 */ delegateTarget: TTarget; @@ -7935,14 +7955,14 @@ declare namespace JQuery { /** * The other DOM element involved in the event, if any. * - * @see {@link https://api.jquery.com/event.relatedTarget/} + * @see \`{@link https://api.jquery.com/event.relatedTarget/ }\` * @since 1.1.4 */ relatedTarget: TTarget | null; /** * The DOM element that initiated the event. * - * @see {@link https://api.jquery.com/event.target/} + * @see \`{@link https://api.jquery.com/event.target/ }\` * @since 1.0 */ target: TTarget; @@ -8149,92 +8169,92 @@ interface JQueryParam { interface BaseJQueryEventObject extends Event { /** * The current DOM element within the event bubbling phase. - * @see {@link https://api.jquery.com/event.currentTarget/} + * @see \`{@link https://api.jquery.com/event.currentTarget/ }\` */ currentTarget: Element; /** * An optional object of data passed to an event method when the current executing handler is bound. - * @see {@link https://api.jquery.com/event.data/} + * @see \`{@link https://api.jquery.com/event.data/ }\` */ data: any; /** * The element where the currently-called jQuery event handler was attached. - * @see {@link https://api.jquery.com/event.delegateTarget/} + * @see \`{@link https://api.jquery.com/event.delegateTarget/ }\` */ delegateTarget: Element; /** * Returns whether event.preventDefault() was ever called on this event object. - * @see {@link https://api.jquery.com/event.isDefaultPrevented/} + * @see \`{@link https://api.jquery.com/event.isDefaultPrevented/ }\` */ isDefaultPrevented(): boolean; /** * Returns whether event.stopImmediatePropagation() was ever called on this event object. - * @see {@link https://api.jquery.com/event.isImmediatePropagationStopped/} + * @see \`{@link https://api.jquery.com/event.isImmediatePropagationStopped/ }\` */ isImmediatePropagationStopped(): boolean; /** * Returns whether event.stopPropagation() was ever called on this event object. - * @see {@link https://api.jquery.com/event.isPropagationStopped/} + * @see \`{@link https://api.jquery.com/event.isPropagationStopped/ }\` */ isPropagationStopped(): boolean; /** * The namespace specified when the event was triggered. - * @see {@link https://api.jquery.com/event.namespace/} + * @see \`{@link https://api.jquery.com/event.namespace/ }\` */ namespace: string; /** * The browser's original Event object. - * @see {@link https://api.jquery.com/category/events/event-object/} + * @see \`{@link https://api.jquery.com/category/events/event-object/ }\` */ originalEvent: Event; /** * If this method is called, the default action of the event will not be triggered. - * @see {@link https://api.jquery.com/event.preventDefault/} + * @see \`{@link https://api.jquery.com/event.preventDefault/ }\` */ preventDefault(): any; /** * The other DOM element involved in the event, if any. - * @see {@link https://api.jquery.com/event.relatedTarget/} + * @see \`{@link https://api.jquery.com/event.relatedTarget/ }\` */ relatedTarget: Element; /** * The last value returned by an event handler that was triggered by this event, unless the value was undefined. - * @see {@link https://api.jquery.com/event.result/} + * @see \`{@link https://api.jquery.com/event.result/ }\` */ result: any; /** * Keeps the rest of the handlers from being executed and prevents the event from bubbling up the DOM tree. - * @see {@link https://api.jquery.com/event.stopImmediatePropagation/} + * @see \`{@link https://api.jquery.com/event.stopImmediatePropagation/ }\` */ stopImmediatePropagation(): void; /** * Prevents the event from bubbling up the DOM tree, preventing any parent handlers from being notified of the event. - * @see {@link https://api.jquery.com/event.stopPropagation/} + * @see \`{@link https://api.jquery.com/event.stopPropagation/ }\` */ stopPropagation(): void; /** * The DOM element that initiated the event. - * @see {@link https://api.jquery.com/event.target/} + * @see \`{@link https://api.jquery.com/event.target/ }\` */ target: Element; /** * The mouse position relative to the left edge of the document. - * @see {@link https://api.jquery.com/event.pageX/} + * @see \`{@link https://api.jquery.com/event.pageX/ }\` */ pageX: number; /** * The mouse position relative to the top edge of the document. - * @see {@link https://api.jquery.com/event.pageY/} + * @see \`{@link https://api.jquery.com/event.pageY/ }\` */ pageY: number; /** * For key or mouse events, this property indicates the specific key or button that was pressed. - * @see {@link https://api.jquery.com/event.which/} + * @see \`{@link https://api.jquery.com/event.which/ }\` */ which: number; /** * Indicates whether the META key was pressed when the event fired. - * @see {@link https://api.jquery.com/event.metaKey/} + * @see \`{@link https://api.jquery.com/event.metaKey/ }\` */ metaKey: boolean; } diff --git a/types/jquery/jquery-tests.ts b/types/jquery/jquery-tests.ts index a8b47cddd1..f0d1ce5ef8 100644 --- a/types/jquery/jquery-tests.ts +++ b/types/jquery/jquery-tests.ts @@ -7058,7 +7058,7 @@ function JQuery_jqXHR() { } } - function compatibleWithPromise(): Promise { + function compatibleWithPromise(): JQuery._Promise { return p; } @@ -7480,7 +7480,7 @@ function JQuery_Promise3() { return s; } - function compatibleWithPromise(): Promise { + function compatibleWithPromise(): JQuery._Promise { return p; } @@ -7624,7 +7624,7 @@ function JQuery_Promise2(p: JQuery.Promise2 { + function compatibleWithPromise(): JQuery._Promise { return p; } @@ -7745,7 +7745,7 @@ function JQuery_Promise(p: JQuery.Promise) { return s; } - function compatibleWithPromise(): Promise { + function compatibleWithPromise(): JQuery._Promise { return p; } } diff --git a/types/jquery/test/bluebird-global-tests.ts b/types/jquery/test/bluebird-global-tests.ts new file mode 100644 index 0000000000..3b7f58e9cd --- /dev/null +++ b/types/jquery/test/bluebird-global-tests.ts @@ -0,0 +1,4 @@ +/// + +// Pulls in bluebird-global to test compatibility. +// Fixes https://github.com/DefinitelyTyped/DefinitelyTyped/issues/26328. diff --git a/types/jquery/tsconfig.json b/types/jquery/tsconfig.json index e481dc63c6..40a0bc76d4 100644 --- a/types/jquery/tsconfig.json +++ b/types/jquery/tsconfig.json @@ -21,6 +21,7 @@ "files": [ "index.d.ts", "jquery-tests.ts", + "test/bluebird-global-tests.ts", "test/example-tests.ts", "test/longdesc-tests.ts", "test/learn-tests.ts", @@ -29,4 +30,4 @@ "test/jquery-slim-no-window-module-tests.ts", "test/jquery-slim-window-module-tests.ts" ] -} \ No newline at end of file +} diff --git a/types/nodemailer/index.d.ts b/types/nodemailer/index.d.ts index 0b46c67789..31175bd148 100644 --- a/types/nodemailer/index.d.ts +++ b/types/nodemailer/index.d.ts @@ -2,6 +2,7 @@ // Project: https://github.com/nodemailer/nodemailer // Definitions by: Rogier Schouten // Piotr Roszatycki +// Daniel Chao // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped // TypeScript Version: 2.3 diff --git a/types/nodemailer/lib/sendmail-transport.d.ts b/types/nodemailer/lib/sendmail-transport/index.d.ts similarity index 84% rename from types/nodemailer/lib/sendmail-transport.d.ts rename to types/nodemailer/lib/sendmail-transport/index.d.ts index 92e461b01b..d1bc9b888b 100644 --- a/types/nodemailer/lib/sendmail-transport.d.ts +++ b/types/nodemailer/lib/sendmail-transport/index.d.ts @@ -1,14 +1,12 @@ /// -import { EventEmitter } from 'events'; +import { Transport, TransportOptions } from '../..'; -import { Transport, TransportOptions } from '..'; +import * as shared from '../shared'; -import * as shared from './shared'; - -import Mail = require('./mailer'); -import MailMessage = require('./mailer/mail-message'); -import MimeNode = require('./mime-node'); +import Mail = require('../mailer'); +import MailMessage = require('../mailer/mail-message'); +import MimeNode = require('../mime-node'); declare namespace SendmailTransport { type MailOptions = Mail.Options; diff --git a/types/nodemailer/lib/sendmail-transport/le-unix.d.ts b/types/nodemailer/lib/sendmail-transport/le-unix.d.ts new file mode 100644 index 0000000000..5f5a3bb25d --- /dev/null +++ b/types/nodemailer/lib/sendmail-transport/le-unix.d.ts @@ -0,0 +1,7 @@ +/// + +import { Transform } from 'stream'; + +declare class LeUnix extends Transform {} + +export = LeUnix; diff --git a/types/nodemailer/lib/sendmail-transport/le-windows.d.ts b/types/nodemailer/lib/sendmail-transport/le-windows.d.ts new file mode 100644 index 0000000000..67ab01ff43 --- /dev/null +++ b/types/nodemailer/lib/sendmail-transport/le-windows.d.ts @@ -0,0 +1,7 @@ +/// + +import { Transform } from 'stream'; + +declare class LeWindows extends Transform {} + +export = LeWindows; diff --git a/types/nodemailer/nodemailer-tests.ts b/types/nodemailer/nodemailer-tests.ts index 0caa84b0e0..6f045df08b 100644 --- a/types/nodemailer/nodemailer-tests.ts +++ b/types/nodemailer/nodemailer-tests.ts @@ -21,6 +21,8 @@ import SMTPTransport = require('nodemailer/lib/smtp-transport'); import StreamTransport = require('nodemailer/lib/stream-transport'); import wellKnown = require('nodemailer/lib/well-known'); import XOAuth2 = require('nodemailer/lib/xoauth2'); +import LeWindows = require('nodemailer/lib/sendmail-transport/le-windows'); +import LeUnix = require('nodemailer/lib/sendmail-transport/le-unix'); import * as fs from 'fs'; import * as stream from 'stream'; @@ -722,6 +724,24 @@ function sendmail_test() { }); } +// line ending transforms using windows-style newlines + +function sendmail_line_endings_windows_test() { + function process_le(mail: MailMessage) { + const input = mail.message.createReadStream(); + input.pipe(new LeWindows()); + } +} + +// line ending transforms using unix-style newlines + +function sendmail_line_endings_unix_test() { + function process_le(mail: MailMessage) { + const input = mail.message.createReadStream(); + input.pipe(new LeUnix()); + } +} + // 5. SES transport // Send a message using SES transport diff --git a/types/nodemailer/tsconfig.json b/types/nodemailer/tsconfig.json index f2c1ffbbe8..5977291812 100644 --- a/types/nodemailer/tsconfig.json +++ b/types/nodemailer/tsconfig.json @@ -31,7 +31,9 @@ "lib/mime-funcs/mime-types.d.ts", "lib/mime-node.d.ts", "lib/qp.d.ts", - "lib/sendmail-transport.d.ts", + "lib/sendmail-transport/index.d.ts", + "lib/sendmail-transport/le-unix.d.ts", + "lib/sendmail-transport/le-windows.d.ts", "lib/ses-transport.d.ts", "lib/shared.d.ts", "lib/smtp-connection.d.ts", diff --git a/types/office-js/index.d.ts b/types/office-js/index.d.ts index 2f75744015..6ba112efaa 100644 --- a/types/office-js/index.d.ts +++ b/types/office-js/index.d.ts @@ -5765,9 +5765,6 @@ declare namespace Office { Last = "last" } } - interface AsyncContextOptions { - asyncContext?: any; - } interface CoercionTypeOptions { coercionType?: CoercionType; } @@ -5895,12 +5892,17 @@ declare namespace Office { * * @remarks * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadWriteItem + * * Applicable Outlook mode: Compose + * * Errors: DataExceedsMaximumSize - The data parameter is longer than 1,000,000 characters. * * In addition to the main signature, this method also has these signatures: + * * prependAsync(data: string, options: AsyncContextOptions & CoercionTypeOptions): void; + * * prependAsync(data: string, callback: (result: AsyncResult) => void): void; + * * prependAsync(data: string): void; * * @param data The string to be inserted at the beginning of the body. The string is limited to 1,000,000 characters. @@ -5921,7 +5923,9 @@ declare namespace Office { * * @remarks * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadWriteItem + * * Applicable Outlook mode: Compose + * * Errors: DataExceedsMaximumSize - The data parameter is longer than 1,000,000 characters. * * @param data The string to be inserted at the beginning of the body. The string is limited to 1,000,000 characters. @@ -5984,9 +5988,12 @@ declare namespace Office { * InvalidFormatError - The options.coercionType parameter is set to Office.CoercionType.Html and the message body is in plain text. * * In addition to the main signature, this method also has these signatures: + * * setAsync(data: string, options: AsyncContextOptions & CoercionTypeOptions): void; + * * setAsync(data: string, callback: (result: AsyncResult) => void): void; - * setAsync(data: string): void; * + * + * setAsync(data: string): void; * * @param data The string that will replace the existing body. The string is limited to 1,000,000 characters. * @param options Optional. An object literal that contains one or more of the following properties. @@ -6082,10 +6089,13 @@ declare namespace Office { * InvalidFormatError - The options.coercionType parameter is set to Office.CoercionType.Html and the message body is in plain text. * * In addition to the main signature, this method also has these signatures: + * * setSelectedDataAsync(data: string, options: AsyncContextOptions & CoercionTypeOptions): void; + * * setSelectedDataAsync(data: string, callback: (result: AsyncResult) => void): void; - * setSelectedDataAsync(data: string): void; * - * * + * + * setSelectedDataAsync(data: string): void; + * * @param data The string that will replace the existing body. The string is limited to 1,000,000 characters. * @param options Optional. An object literal that contains one or more of the following properties. * asyncContext: Developers can provide any object they wish to access in the callback method. @@ -6464,6 +6474,7 @@ declare namespace Office { * Applicable Outlook mode: Compose * * In addition to this signature, the method also has the following signatures: + * * getAsync(callback?: (result: AsyncResult) => void): void; * * @param options An object literal that contains one or more of the following properties. @@ -6492,22 +6503,22 @@ declare namespace Office { } /** + * The subclass of {@link Office.Item} dealing with apppointments. + * * Important: This is an internal Outlook object, not directly exposed through existing interfaces. You should treat this as a mode of Office.context.mailbox.item. Refer to the Object Model pages for more information. */ interface Appointment extends Item { } /** - * Important: This is an internal Outlook object, not directly exposed through existing interfaces. You should treat this as a mode of Office.context.mailbox.item. Refer to the Object Model pages for more information. + * The appointment organizer mode of {@link Office.Item | Office.context.mailbox.item}. + * + * Important: This is an internal Outlook object, not directly exposed through existing interfaces. You should treat this as a mode of **Office.context.mailbox.item**. Refer to the Object Model pages for more information. */ interface AppointmentCompose extends Appointment, ItemCompose { /** * Gets or sets the date and time that the appointment is to end. * - * The end property is expressed as a Coordinated Universal Time (UTC) date and time value. You can use the convertToLocalClientTime method to convert the end property value to the client's local date and time. - * - * *Compose mode* - * - * The end property returns a Time object. + * The end property is an {@link Office.Time} object expressed as a Coordinated Universal Time (UTC) date and time value. You can use the convertToLocalClientTime method to convert the end property value to the client's local date and time. * * When you use the Time.setAsync method to set the end time, you should use the convertToUtcClientTime method to convert the local time on the client to UTC for the server. * @@ -6517,15 +6528,11 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadItem * - * Applicable Outlook mode: Compose or read + * Applicable Outlook mode: Appointment Organizer */ end: Time; /** - * Gets or sets the location of an appointment. - * - * *Compose mode* - * - * The location property returns a Location object that provides methods that are used to get and set the location of the appointment. + * Gets or sets the {@link Office.Location} of an appointment. The location property returns a Location object that provides methods that are used to get and set the location of the appointment. * * [Api set: Mailbox 1.0] * @@ -6533,15 +6540,11 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadItem * - * Applicable Outlook mode: Compose or read + * Applicable Outlook mode: Appointment Organizer */ location: Location; /** - * Provides access to the optional attendees of an event. The type of object and level of access depends on the mode of the current item. - * - * *Compose mode* - * - * The optionalAttendees property returns a Recipients object that provides methods to get or update the optional attendees for a meeting. + * Provides access to the optional attendees of an event. The type of object and level of access depends on the mode of the current item. The optionalAttendees property returns an {@link Office.Recipients} object that provides methods to get or update the optional attendees for a meeting. * * [Api set: Mailbox 1.0] * @@ -6549,15 +6552,11 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadItem * - * Applicable Outlook mode: Compose or read + * Applicable Outlook mode: Appointment Organizer */ optionalAttendees: Recipients; /** - * Provides access to the required attendees of an event. The type of object and level of access depends on the mode of the current item. - * - * *Compose mode* - * - * The requiredAttendees property returns a Recipients object that provides methods to get or update the required attendees for a meeting. + * Provides access to the required attendees of an event. The type of object and level of access depends on the mode of the current item. The requiredAttendees property returns an {@link Office.Recipients} object that provides methods to get or update the required attendees for a meeting. * * [Api set: Mailbox 1.0] * @@ -6565,17 +6564,13 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadItem * - * Applicable Outlook mode: Compose or read + * Applicable Outlook mode: Appointment Organizer */ requiredAttendees: Recipients; /** * Gets or sets the date and time that the appointment is to begin. * - * The start property is expressed as a Coordinated Universal Time (UTC) date and time value. You can use the convertToLocalClientTime method to convert the value to the client's local date and time. - * - * *Compose mode* - * - * The start property returns a Time object. + * The start property is an {@link Office.Time} object expressed as a Coordinated Universal Time (UTC) date and time value. You can use the convertToLocalClientTime method to convert the value to the client's local date and time. * * When you use the Time.setAsync method to set the start time, you should use the convertToUtcClientTime method to convert the local time on the client to UTC for the server. * @@ -6585,20 +6580,863 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadItem * - * Applicable Outlook mode: Compose or read + * Applicable Outlook mode: Appointment Organizer */ start: Time; + + // Repeated Item fields // + + /** + * Gets an object that provides methods for manipulating the body of an item. + * + * [Api set: Mailbox 1.1] + * + * @remarks + * + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadItem + * + * Applicable Outlook mode: Appointment Organizer + */ + body: Body; + /** + * Gets the date and time that an item was created. Read mode only. + * + * [Api set: Mailbox 1.0] + * + * @remarks + * + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadItem + * + * Applicable Outlook mode: Appointment Organizer + */ + dateTimeCreated: Date; + /** + * Gets the date and time that an item was last modified. Read mode only. + * + * [Api set: Mailbox 1.0] + * + * @remarks + * + * Note: This member is not supported in Outlook for iOS or Outlook for Android. + * + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadItem + * + * Applicable Outlook mode: Appointment Organizer + */ + dateTimeModifed: Date; + /** + * Gets the type of item that an instance represents. + * + * The itemType property returns one of the ItemType enumeration values, indicating whether the item object instance is a message or an appointment. + * + * [Api set: Mailbox 1.0] + * + * @remarks + * + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadItem + * + * Applicable Outlook mode: Appointment Organizer + */ + itemType: Office.MailboxEnums.ItemType; + /** + * Gets the notification messages for an item. + * + * [Api set: Mailbox 1.3] + * + * @remarks + * + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadItem + * + * Applicable Outlook mode: Appointment Organizer + */ + notificationMessages: NotificationMessages; + + /** + * Gets or sets the recurrence pattern of an appointment. + * + * The recurrence property returns a recurrence object for recurring appointments or meetings requests if an item is a series or an instance in a series. null is returned for single appointments and meeting requests of single appointments. + * + * Note: Meeting requests have an itemClass value of IPM.Schedule.Meeting.Request. + * + * Note: If the recurrence object is null, this indicates that the object is a single appointment or a meeting request of a single appointment and NOT a part of a series. + * + * [Api set: Mailbox Preview] + * + * @remarks + * + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadItem + * + * Applicable Outlook mode: Appointment Organizer + */ + recurrence: Recurrence; + + /** + * Gets the id of the series that an instance belongs to. + * + * In OWA and Outlook, the seriesId returns the Exchange Web Services (EWS) ID of the parent (series) item that this item belongs to. However, in iOS and Android, the seriesId returns the REST ID of the parent item. + * + * Note: The identifier returned by the seriesId property is the same as the Exchange Web Services item identifier. The seriesId property is not identical to the Outlook IDs used by the Outlook REST API. Before making REST API calls using this value, it should be converted using Office.context.mailbox.convertToRestId. For more details, see {@link https://docs.microsoft.com/outlook/add-ins/use-rest-api | Use the Outlook REST APIs from an Outlook add-in}. + * + * The seriesId property returns null for items that do not have parent items such as single appointments, series items, or meeting requests and returns undefined for any other items that are not meeting requests. + * + * [Api set: Mailbox Preview] + * + * @remarks + * + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadItem + * + * Applicable Outlook mode: Appointment Organizer + */ + seriesId: string; + + /** + * Adds an event handler for a supported event. + * + * Currently the only supported event type is Office.EventType.RecurrencePatternChanged, which is invoked when the user changes the recurrence pattern of a series. + * + * [Api set: Mailbox Preview] + * + * @remarks + * + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadItem + * + * In addition to this signature, the method also has the following signatures: + * + * addHandlerAsync(eventType:EventType, handler: any, callback?: (result: AsyncResult) => void): void; + * + * Applicable Outlook mode: Appointment Organizer + * + * @param eventType The event that should invoke the handler. + * @param handler The function to handle the event. The function must accept a single parameter, which is an object literal. The type property on the parameter will match the eventType parameter passed to addHandlerAsync. + * @param options Optional. An object literal that contains one or more of the following properties. + * asyncContext: Developers can provide any object they wish to access in the callback method. + * @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter, asyncResult, which is an AsyncResult object. + */ + addHandlerAsync(eventType:EventType, handler: any, options?: any, callback?: (result: AsyncResult) => void): void; + + /** + * Adds an event handler for a supported event. + * + * Currently the only supported event type is Office.EventType.RecurrencePatternChanged, which is invoked when the user changes the recurrence pattern of a series. + * + * [Api set: Mailbox Preview] + * + * @remarks + * + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadItem + * + * Applicable Outlook mode: Appointment Organizer + * + * @param eventType The event that should invoke the handler. + * @param handler The function to handle the event. The function must accept a single parameter, which is an object literal. The type property on the parameter will match the eventType parameter passed to addHandlerAsync. + * @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter, asyncResult, which is an AsyncResult object. + */ + addHandlerAsync(eventType:EventType, handler: any, callback?: (result: AsyncResult) => void): void; + + /** + * Asynchronously loads custom properties for this add-in on the selected item. + * + * Custom properties are stored as key/value pairs on a per-app, per-item basis. This method returns a CustomProperties object in the callback, which provides methods to access the custom properties specific to the current item and the current add-in. Custom properties are not encrypted on the item, so this should not be used as secure storage. + * + * The custom properties are provided as a CustomProperties object in the asyncResult.value property. This object can be used to get, set, and remove custom properties from the item and save changes to the custom property set back to the server. + * + * [Api set: Mailbox 1.0] + * + * @remarks + * + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadItem + * + * Applicable Outlook mode: Appointment Organizer + * + * @param callback When the method completes, the function passed in the callback parameter is called with a single parameter of type AsyncResult. + * @param userContext Optional. Developers can provide any object they wish to access in the callback function. This object can be accessed by the asyncResult.asyncContext property in the callback function. + */ + loadCustomPropertiesAsync(callback: (result: AsyncResult) => void, userContext?: any): void; + + /** + * Removes an event handler for a supported event. + * + * Currently the only supported event type is Office.EventType.RecurrencePatternChanged, which is invoked when the user changes the recurrence pattern of a series. + * + * [Api set: Mailbox Preview] + * + * @remarks + * + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadItem + * + * Applicable Outlook mode: Appointment Organizer + * + * In addition to this signature, the method also has the following signatures: + * + * removeHandlerAsync(eventType:EventType, handler: any, callback?: (result: AsyncResult) => void): void; + * + * @param eventType The event that should invoke the handler. + * @param handler The function to handle the event. The function must accept a single parameter, which is an object literal. The type property on the parameter will match the eventType parameter passed to removeHandlerAsync. + * @param options Optional. An object literal that contains one or more of the following properties. + * asyncContext: Developers can provide any object they wish to access in the callback method. + * @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter, asyncResult, which is an AsyncResult object. + */ + removeHandlerAsync(eventType:EventType, handler: any, options?: any, callback?: (result: AsyncResult) => void): void; + + /** + * Removes an event handler for a supported event. + * + * Currently the only supported event type is Office.EventType.RecurrencePatternChanged, which is invoked when the user changes the recurrence pattern of a series. + * + * [Api set: Mailbox Preview] + * + * @remarks + * + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadItem + * + * Applicable Outlook mode: Appointment Organizer + * + * @param eventType The event that should invoke the handler. + * @param handler The function to handle the event. The function must accept a single parameter, which is an object literal. The type property on the parameter will match the eventType parameter passed to removeHandlerAsync. + * @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter, asyncResult, which is an AsyncResult object. + */ + removeHandlerAsync(eventType:EventType, handler: any, callback?: (result: AsyncResult) => void): void; + + /** + * Gets or sets the description that appears in the subject field of an item. + * + * The subject property gets or sets the entire subject of the item, as sent by the email server. + * + * The subject property returns a Subject object that provides methods to get and set the subject. + * + * [Api set: Mailbox 1.0] + * + * @remarks + * + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadItem + * + * Applicable Outlook mode: Appointment Organizer + */ + subject: Subject; + /** + * Adds a file to a message or appointment as an attachment. + * + * The addFileAttachmentAsync method uploads the file at the specified URI and attaches it to the item in the compose form. + * + * You can subsequently use the identifier with the removeAttachmentAsync method to remove the attachment in the same session. + * + * [Api set: Mailbox 1.1] + * + * @remarks + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadWriteItem + * + * Applicable Outlook mode: Appointment Organizer + * + * Errors: + * + * AttachmentSizeExceeded - The attachment is larger than allowed. + * + * FileTypeNotSupported - The attachment has an extension that is not allowed. + * + * NumberOfAttachmentsExceeded - The message or appointment has too many attachments. + * + * In addition to this signature, the method also has the following signatures: + * + * addFileAttachmentAsync(uri: string, attachmentName: string): void; + * + * addFileAttachmentAsync(uri: string, attachmentName: string, options: AsyncContextOptions): void; + * + * addFileAttachmentAsync(uri: string, attachmentName: string, callback: (result: AsyncResult) => void): void; + * + * @param uri The URI that provides the location of the file to attach to the message or appointment. The maximum length is 2048 characters. + * @param attachmentName The name of the attachment that is shown while the attachment is uploading. The maximum length is 255 characters. + * @param options Optional. An object literal that contains one or more of the following properties. + * asyncContext: Developers can provide any object they wish to access in the callback method. + * inInline: If true, indicates that the attachment will be shown inline in the message body, and should not be displayed in the attachment list. + * @param callback When the method completes, the function passed in the callback parameter is called with a single parameter of type asyncResult. On success, the attachment identifier will be provided in the asyncResult.value property. If uploading the attachment fails, the asyncResult object will contain an Error object that provides a description of the error. + */ + addFileAttachmentAsync(uri: string, attachmentName: string, options?: AsyncContextOptions, callback?: (result: AsyncResult) => void): void; + /** + * Adds a file to a message or appointment as an attachment. + * + * The addFileAttachmentAsync method uploads the file at the specified URI and attaches it to the item in the compose form. + * + * You can subsequently use the identifier with the removeAttachmentAsync method to remove the attachment in the same session. + * + * [Api set: Mailbox 1.1] + * + * @remarks + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadWriteItem + * + * Applicable Outlook mode: Appointment Organizer + * + * Errors: + * + * AttachmentSizeExceeded - The attachment is larger than allowed. + * + * FileTypeNotSupported - The attachment has an extension that is not allowed. + * + * NumberOfAttachmentsExceeded - The message or appointment has too many attachments. + * + * @param uri The URI that provides the location of the file to attach to the message or appointment. The maximum length is 2048 characters. + * @param attachmentName The name of the attachment that is shown while the attachment is uploading. The maximum length is 255 characters. + */ + addFileAttachmentAsync(uri: string, attachmentName: string): void; + /** + * Adds a file to a message or appointment as an attachment. + * + * The addFileAttachmentAsync method uploads the file at the specified URI and attaches it to the item in the compose form. + * + * You can subsequently use the identifier with the removeAttachmentAsync method to remove the attachment in the same session. + * + * [Api set: Mailbox 1.1] + * + * @remarks + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadWriteItem + * + * Applicable Outlook mode: Appointment Organizer + * + * Errors: + * + * AttachmentSizeExceeded - The attachment is larger than allowed. + * + * FileTypeNotSupported - The attachment has an extension that is not allowed. + * + * NumberOfAttachmentsExceeded - The message or appointment has too many attachments. + * + * @param uri The URI that provides the location of the file to attach to the message or appointment. The maximum length is 2048 characters. + * @param attachmentName The name of the attachment that is shown while the attachment is uploading. The maximum length is 255 characters. + * @param options Optional. An object literal that contains one or more of the following properties. + * asyncContext: Developers can provide any object they wish to access in the callback method. + * inInline: If true, indicates that the attachment will be shown inline in the message body, and should not be displayed in the attachment list. + */ + addFileAttachmentAsync(uri: string, attachmentName: string, options: AsyncContextOptions): void; + /** + * Adds a file to a message or appointment as an attachment. + * + * The addFileAttachmentAsync method uploads the file at the specified URI and attaches it to the item in the compose form. + * + * You can subsequently use the identifier with the removeAttachmentAsync method to remove the attachment in the same session. + * + * [Api set: Mailbox 1.1] + * + * @remarks + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadWriteItem + * + * Applicable Outlook mode: Appointment Organizer + * + * Errors: + * + * AttachmentSizeExceeded - The attachment is larger than allowed. + * + * FileTypeNotSupported - The attachment has an extension that is not allowed. + * + * NumberOfAttachmentsExceeded - The message or appointment has too many attachments. + * + * @param uri The URI that provides the location of the file to attach to the message or appointment. The maximum length is 2048 characters. + * @param attachmentName The name of the attachment that is shown while the attachment is uploading. The maximum length is 255 characters. + * @param callback When the method completes, the function passed in the callback parameter is called with a single parameter of type asyncResult. On success, the attachment identifier will be provided in the asyncResult.value property. If uploading the attachment fails, the asyncResult object will contain an Error object that provides a description of the error. + */ + addFileAttachmentAsync(uri: string, attachmentName: string, callback: (result: AsyncResult) => void): void; + + /** + * Adds an Exchange item, such as a message, as an attachment to the message or appointment. + * + * The addItemAttachmentAsync method attaches the item with the specified Exchange identifier to the item in the compose form. If you specify a callback method, the method is called with one parameter, asyncResult, which contains either the attachment identifier or a code that indicates any error that occurred while attaching the item. You can use the options parameter to pass state information to the callback method, if needed. + * + * You can subsequently use the identifier with the removeAttachmentAsync method to remove the attachment in the same session. + * + * If your Office add-in is running in Outlook Web App, the addItemAttachmentAsync method can attach items to items other than the item that you are editing; however, this is not supported and is not recommended. + * + * [Api set: Mailbox 1.1] + * + * @remarks + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadWriteItem + * + * Applicable Outlook mode: Appointment Organizer + * + * Errors: + * + * NumberOfAttachmentsExceeded - The message or appointment has too many attachments. + * + * In addition to the main signature, this method also has these signatures: + * + * addItemAttachmentAsync(itemId: any, attachmentName: string): void; + * + * addItemAttachmentAsync(itemId: any, attachmentName: string, options: AsyncContextOptions): void; + * + * addItemAttachmentAsync(itemId: any, attachmentName: string, callback: (result: AsyncResult) => void): void; + * + * @param itemId The Exchange identifier of the item to attach. The maximum length is 100 characters. + * @param attachmentName The name of the attachment that is shown while the attachment is uploading. The maximum length is 255 characters. + * @param options An object literal that contains one or more of the following properties. + * asyncContext: Developers can provide any object they wish to access in the callback method. + * @param callback When the method completes, the function passed in the callback parameter is called with a single parameter of type AsyncResult. On success, the attachment identifier will be provided in the asyncResult.value property. If adding the attachment fails, the asyncResult object will contain an Error object that provides a description of the error. + */ + addItemAttachmentAsync(itemId: any, attachmentName: string, options?: AsyncContextOptions, callback?: (result: AsyncResult) => void): void; + /** + * Adds an Exchange item, such as a message, as an attachment to the message or appointment. + * + * The addItemAttachmentAsync method attaches the item with the specified Exchange identifier to the item in the compose form. If you specify a callback method, the method is called with one parameter, asyncResult, which contains either the attachment identifier or a code that indicates any error that occurred while attaching the item. You can use the options parameter to pass state information to the callback method, if needed. + * + * You can subsequently use the identifier with the removeAttachmentAsync method to remove the attachment in the same session. + * + * If your Office add-in is running in Outlook Web App, the addItemAttachmentAsync method can attach items to items other than the item that you are editing; however, this is not supported and is not recommended. + * + * [Api set: Mailbox 1.1] + * + * @remarks + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadWriteItem + * + * Applicable Outlook mode: Appointment Organizer + * + * Errors: + * + * NumberOfAttachmentsExceeded - The message or appointment has too many attachments. + * + * @param itemId The Exchange identifier of the item to attach. The maximum length is 100 characters. + * @param attachmentName The name of the attachment that is shown while the attachment is uploading. The maximum length is 255 characters. + */ + addItemAttachmentAsync(itemId: any, attachmentName: string): void; + /** + * Adds an Exchange item, such as a message, as an attachment to the message or appointment. + * + * The addItemAttachmentAsync method attaches the item with the specified Exchange identifier to the item in the compose form. If you specify a callback method, the method is called with one parameter, asyncResult, which contains either the attachment identifier or a code that indicates any error that occurred while attaching the item. You can use the options parameter to pass state information to the callback method, if needed. + * + * You can subsequently use the identifier with the removeAttachmentAsync method to remove the attachment in the same session. + * + * If your Office add-in is running in Outlook Web App, the addItemAttachmentAsync method can attach items to items other than the item that you are editing; however, this is not supported and is not recommended. + * + * [Api set: Mailbox 1.1] + * + * @remarks + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadWriteItem + * + * Applicable Outlook mode: Appointment Organizer + * + * Errors: + * + * NumberOfAttachmentsExceeded - The message or appointment has too many attachments. + * + * @param itemId The Exchange identifier of the item to attach. The maximum length is 100 characters. + * @param attachmentName The name of the attachment that is shown while the attachment is uploading. The maximum length is 255 characters. + * @param options An object literal that contains one or more of the following properties. + * asyncContext: Developers can provide any object they wish to access in the callback method. + */ + addItemAttachmentAsync(itemId: any, attachmentName: string, options: AsyncContextOptions): void; + /** + * Adds an Exchange item, such as a message, as an attachment to the message or appointment. + * + * The addItemAttachmentAsync method attaches the item with the specified Exchange identifier to the item in the compose form. If you specify a callback method, the method is called with one parameter, asyncResult, which contains either the attachment identifier or a code that indicates any error that occurred while attaching the item. You can use the options parameter to pass state information to the callback method, if needed. + * + * You can subsequently use the identifier with the removeAttachmentAsync method to remove the attachment in the same session. + * + * If your Office add-in is running in Outlook Web App, the addItemAttachmentAsync method can attach items to items other than the item that you are editing; however, this is not supported and is not recommended. + * + * [Api set: Mailbox 1.1] + * + * @remarks + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadWriteItem + * + * Applicable Outlook mode: Appointment Organizer + * + * Errors: + * + * NumberOfAttachmentsExceeded - The message or appointment has too many attachments. + * + * @param itemId The Exchange identifier of the item to attach. The maximum length is 100 characters. + * @param attachmentName The name of the attachment that is shown while the attachment is uploading. The maximum length is 255 characters. + * @param callback When the method completes, the function passed in the callback parameter is called with a single parameter of type AsyncResult. On success, the attachment identifier will be provided in the asyncResult.value property. If adding the attachment fails, the asyncResult object will contain an Error object that provides a description of the error. + */ + addItemAttachmentAsync(itemId: any, attachmentName: string, callback: (result: AsyncResult) => void): void; + + /** + * Closes the current item that is being composed + * + * The behaviors of the close method depends on the current state of the item being composed. If the item has unsaved changes, the client prompts the user to save, discard, or close the action. + * + * In the Outlook desktop client, if the message is an inline reply, the close method has no effect. + * + * Note: In Outlook on the web, if the item is an appointment and it has previously been saved using saveAsync, the user is prompted to save, discard, or cancel even if no changes have occurred since the item was last saved. + * + * [Api set: Mailbox 1.3] + * + * @remarks + * + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: Restricted + * + * Applicable Outlook mode: Appointment Organizer + */ + close(): void; + /** + * Gets initialization data passed when the add-in is activated by an actionable message. + * + * Note: This method is only supported by Outlook 2016 for Windows (Click-to-Run versions greater than 16.0.8413.1000) and Outlook on the web for Office 365. + * + * [Api set: Mailbox Preview] + * + * @remarks + * + * More information on {@link https://docs.microsoft.com/outlook/actionable-messages/invoke-add-in-from-actionable-message | actionable messages}. + * + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadItem + * + * Applicable Outlook mode: Appointment Organizer + * + * @param options Optional. An object literal that contains one or more of the following properties. + * asyncContext: Developers can provide any object they wish to access in the callback method. + * @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of type AsyncResult. On success, the initialization data is provided in the asyncResult.value property as a string. If there is no initialization context, the asyncResult object will contain an Error object with its code property set to 9020 and its name property set to GenericResponseError. + */ + getInitializationContextAsync(options?: AsyncContextOptions, callback?: (result: AsyncResult) => void): void; + /** + * Asynchronously returns selected data from the subject or body of a message. + * + * If there is no selection but the cursor is in the body or subject, the method returns null for the selected data. If a field other than the body or subject is selected, the method returns the InvalidSelection error. + * + * To access the selected data from the callback method, call asyncResult.value.data. To access the source property that the selection comes from, call asyncResult.value.sourceProperty, which will be either body or subject. + * + * [Api set: Mailbox 1.0] + * + * @returns + * The selected data as a string with format determined by coercionType. + * + * @remarks + * + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadWriteItem + * + * Applicable Outlook mode: Appointment Organizer + * + * @param coercionType Requests a format for the data. If Text, the method returns the plain text as a string , removing any HTML tags present. If HTML, the method returns the selected text, whether it is plaintext or HTML. + * @param options An object literal that contains one or more of the following properties. + * asyncContext: Developers can provide any object they wish to access in the callback method. + * @param callback When the method completes, the function passed in the callback parameter is called with a single parameter of type AsyncResult. + */ + getSelectedDataAsync(coercionType: CoercionType, options: AsyncContextOptions, callback: (result: AsyncResult) => void): void; + /** + * Asynchronously returns selected data from the subject or body of a message. + * + * If there is no selection but the cursor is in the body or subject, the method returns null for the selected data. If a field other than the body or subject is selected, the method returns the InvalidSelection error. + * + * To access the selected data from the callback method, call asyncResult.value.data. To access the source property that the selection comes from, call asyncResult.value.sourceProperty, which will be either body or subject. + * + * [Api set: Mailbox 1.0] + * + * @returns + * The selected data as a string with format determined by coercionType. + * + * @remarks + * + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadWriteItem + * + * Applicable Outlook mode: Appointment Organizer + * + * @param coercionType Requests a format for the data. If Text, the method returns the plain text as a string , removing any HTML tags present. If HTML, the method returns the selected text, whether it is plaintext or HTML. + * @param callback When the method completes, the function passed in the callback parameter is called with a single parameter of type AsyncResult. + */ + getSelectedDataAsync(coercionType: CoercionType, callback: (result: AsyncResult) => void): void; + /** + * Removes an attachment from a message or appointment. + * + * The removeAttachmentAsync method removes the attachment with the specified identifier from the item. As a best practice, you should use the attachment identifier to remove an attachment only if the same mail app has added that attachment in the same session. In Outlook Web App and OWA for Devices, the attachment identifier is valid only within the same session. A session is over when the user closes the app, or if the user starts composing in an inline form and subsequently pops out the inline form to continue in a separate window. + * + * [Api set: Mailbox 1.1] + * + * @remarks + * + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadWriteItem + * + * Applicable Outlook mode: Appointment Organizer + * + * Errors: InvalidAttachmentId - The attachment identifier does not exist. + * + * In addition to this signature, the method also has the following signatures: + * + * removeAttachmentAsync(attachmentIndex: string): void; + * + * removeAttachmentAsync(attachmentIndex: string, options: AsyncContextOptions): void; + * + * removeAttachmentAsync(attachmentIndex: string, callback: (result: AsyncResult) => void): void; + * + * @param attachmentIndex The identifier of the attachment to remove. The maximum length of the string is 100 characters. + * @param options Optional. An object literal that contains one or more of the following properties. + * asyncContext: Developers can provide any object they wish to access in the callback method. + * @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of type AsyncResult. If removing the attachment fails, the asyncResult.error property will contain an error code with the reason for the failure. + */ + removeAttachmentAsync(attachmentIndex: string, options?: AsyncContextOptions, callback?: (result: AsyncResult) => void): void; + /** + * Removes an attachment from a message or appointment. + * + * The removeAttachmentAsync method removes the attachment with the specified identifier from the item. As a best practice, you should use the attachment identifier to remove an attachment only if the same mail app has added that attachment in the same session. In Outlook Web App and OWA for Devices, the attachment identifier is valid only within the same session. A session is over when the user closes the app, or if the user starts composing in an inline form and subsequently pops out the inline form to continue in a separate window. + * + * [Api set: Mailbox 1.1] + * + * @remarks + * + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadWriteItem + * + * Applicable Outlook mode: Appointment Organizer + * + * Errors: InvalidAttachmentId - The attachment identifier does not exist. + * + * @param attachmentIndex The identifier of the attachment to remove. The maximum length of the string is 100 characters. + */ + removeAttachmentAsync(attachmentIndex: string): void; + /** + * Removes an attachment from a message or appointment. + * + * The removeAttachmentAsync method removes the attachment with the specified identifier from the item. As a best practice, you should use the attachment identifier to remove an attachment only if the same mail app has added that attachment in the same session. In Outlook Web App and OWA for Devices, the attachment identifier is valid only within the same session. A session is over when the user closes the app, or if the user starts composing in an inline form and subsequently pops out the inline form to continue in a separate window. + * + * [Api set: Mailbox 1.1] + * + * @remarks + * + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadWriteItem + * + * Applicable Outlook mode: Appointment Organizer + * + * Errors: InvalidAttachmentId - The attachment identifier does not exist. + * + * @param attachmentIndex The identifier of the attachment to remove. The maximum length of the string is 100 characters. + * @param options Optional. An object literal that contains one or more of the following properties. + * asyncContext: Developers can provide any object they wish to access in the callback method. + */ + removeAttachmentAsync(attachmentIndex: string, options: AsyncContextOptions): void; + /** + * Removes an attachment from a message or appointment. + * + * The removeAttachmentAsync method removes the attachment with the specified identifier from the item. As a best practice, you should use the attachment identifier to remove an attachment only if the same mail app has added that attachment in the same session. In Outlook Web App and OWA for Devices, the attachment identifier is valid only within the same session. A session is over when the user closes the app, or if the user starts composing in an inline form and subsequently pops out the inline form to continue in a separate window. + * + * [Api set: Mailbox 1.1] + * + * @remarks + * + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadWriteItem + * + * Applicable Outlook mode: Appointment Organizer + * + * Errors: InvalidAttachmentId - The attachment identifier does not exist. + * + * @param attachmentIndex The identifier of the attachment to remove. The maximum length of the string is 100 characters. + * @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of type AsyncResult. If removing the attachment fails, the asyncResult.error property will contain an error code with the reason for the failure. + */ + removeAttachmentAsync(attachmentIndex: string, callback: (result: AsyncResult) => void): void; + + /** + * Asynchronously saves an item. + * + * When invoked, this method saves the current message as a draft and returns the item id via the callback method. In Outlook Web App or Outlook in online mode, the item is saved to the server. In Outlook in cached mode, the item is saved to the local cache. + * + * Since appointments have no draft state, if saveAsync is called on an appointment in compose mode, the item will be saved as a normal appointment on the user's calendar. For new appointments that have not been saved before, no invitation will be sent. Saving an existing appointment will send an update to added or removed attendees. + * + * Note: If your add-in calls saveAsync on an item in compose mode in order to get an itemId to use with EWS or the REST API, be aware that when Outlook is in cached mode, it may take some time before the item is actually synced to the server. Until the item is synced, using the itemId will return an error. + * + * Note: The following clients have different behavior for saveAsync on appointments in compose mode: + * + * - Mac Outlook does not support saveAsync on a meeting in compose mode. Calling saveAsync on a meeting in Mac Outlook will return an error. + * + * - Outlook on the web always sends an invitation or update when saveAsync is called on an appointment in compose mode. + * + * [Api set: Mailbox 1.3] + * + * @remarks + * + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadWriteItem + * + * Applicable Outlook mode: Appointment Organizer + * + * Errors: InvalidAttachmentId - The attachment identifier does not exist. + * + * In addition to this signature, the method also has the following signatures: + * + * saveAsync(): void; + * + * saveAsync(options: AsyncContextOptions): void; + * + * saveAsync(callback: (result: AsyncResult) => void): void; + * + * @param options Optional. An object literal that contains one or more of the following properties. + * asyncContext: Developers can provide any object they wish to access in the callback method. + * @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of type AsyncResult. If removing the attachment fails, the asyncResult.error property will contain an error code with the reason for the failure. + */ + saveAsync(options?: AsyncContextOptions, callback?: (result: AsyncResult) => void): void; + /** + * Asynchronously saves an item. + * + * When invoked, this method saves the current message as a draft and returns the item id via the callback method. In Outlook Web App or Outlook in online mode, the item is saved to the server. In Outlook in cached mode, the item is saved to the local cache. + * + * Since appointments have no draft state, if saveAsync is called on an appointment in compose mode, the item will be saved as a normal appointment on the user's calendar. For new appointments that have not been saved before, no invitation will be sent. Saving an existing appointment will send an update to added or removed attendees. + * + * Note: If your add-in calls saveAsync on an item in compose mode in order to get an itemId to use with EWS or the REST API, be aware that when Outlook is in cached mode, it may take some time before the item is actually synced to the server. Until the item is synced, using the itemId will return an error. + * + * Note: The following clients have different behavior for saveAsync on appointments in compose mode: + * + * - Mac Outlook does not support saveAsync on a meeting in compose mode. Calling saveAsync on a meeting in Mac Outlook will return an error. + * + * - Outlook on the web always sends an invitation or update when saveAsync is called on an appointment in compose mode. + * + * [Api set: Mailbox 1.3] + * + * @remarks + * + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadWriteItem + * + * Applicable Outlook mode: Appointment Organizer + * + * Errors: InvalidAttachmentId - The attachment identifier does not exist. + * + */ + saveAsync(): void; + /** + * Asynchronously saves an item. + * + * When invoked, this method saves the current message as a draft and returns the item id via the callback method. In Outlook Web App or Outlook in online mode, the item is saved to the server. In Outlook in cached mode, the item is saved to the local cache. + * + * Since appointments have no draft state, if saveAsync is called on an appointment in compose mode, the item will be saved as a normal appointment on the user's calendar. For new appointments that have not been saved before, no invitation will be sent. Saving an existing appointment will send an update to added or removed attendees. + * + * Note: If your add-in calls saveAsync on an item in compose mode in order to get an itemId to use with EWS or the REST API, be aware that when Outlook is in cached mode, it may take some time before the item is actually synced to the server. Until the item is synced, using the itemId will return an error. + * + * Note: The following clients have different behavior for saveAsync on appointments in compose mode: + * + * - Mac Outlook does not support saveAsync on a meeting in compose mode. Calling saveAsync on a meeting in Mac Outlook will return an error. + * + * - Outlook on the web always sends an invitation or update when saveAsync is called on an appointment in compose mode. + * + * [Api set: Mailbox 1.3] + * + * @remarks + * + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadWriteItem + * + * Applicable Outlook mode: Appointment Organizer + * + * Errors: InvalidAttachmentId - The attachment identifier does not exist. + * + * @param options Optional. An object literal that contains one or more of the following properties. + * asyncContext: Developers can provide any object they wish to access in the callback method. + */ + saveAsync(options: AsyncContextOptions): void; + /** + * Asynchronously saves an item. + * + * When invoked, this method saves the current message as a draft and returns the item id via the callback method. In Outlook Web App or Outlook in online mode, the item is saved to the server. In Outlook in cached mode, the item is saved to the local cache. + * + * Since appointments have no draft state, if saveAsync is called on an appointment in compose mode, the item will be saved as a normal appointment on the user's calendar. For new appointments that have not been saved before, no invitation will be sent. Saving an existing appointment will send an update to added or removed attendees. + * + * Note: If your add-in calls saveAsync on an item in compose mode in order to get an itemId to use with EWS or the REST API, be aware that when Outlook is in cached mode, it may take some time before the item is actually synced to the server. Until the item is synced, using the itemId will return an error. + * + * Note: The following clients have different behavior for saveAsync on appointments in compose mode: + * + * - Mac Outlook does not support saveAsync on a meeting in compose mode. Calling saveAsync on a meeting in Mac Outlook will return an error. + * + * - Outlook on the web always sends an invitation or update when saveAsync is called on an appointment in compose mode. + * + * [Api set: Mailbox 1.3] + * + * @remarks + * + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadWriteItem + * + * Applicable Outlook mode: Appointment Organizer + * + * Errors: InvalidAttachmentId - The attachment identifier does not exist. + * + * @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of type AsyncResult. If removing the attachment fails, the asyncResult.error property will contain an error code with the reason for the failure. + */ + saveAsync(callback: (result: AsyncResult) => void): void; + /** + * Asynchronously inserts data into the body or subject of a message. + * + * The setSelectedDataAsync method inserts the specified string at the cursor location in the subject or body of the item, or, if text is selected in the editor, it replaces the selected text. If the cursor is not in the body or subject field, an error is returned. After insertion, the cursor is placed at the end of the inserted content. + * + * [Api set: Mailbox 1.2] + * + * @remarks + * + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadWriteItem + * + * Applicable Outlook mode: Appointment Organizer + * + * Errors: InvalidAttachmentId - The attachment identifier does not exist. + * + * In addition to this signature, the method also has the following signatures: + * + * setSelectedDataAsync(data: string): void; + * + * setSelectedDataAsync(data: string, options: AsyncContextOptions & CoercionTypeOptions): void; + * + * setSelectedDataAsync(data: string, callback: (result: AsyncResult) => void): void; + * + * @param data The data to be inserted. Data is not to exceed 1,000,000 characters. If more than 1,000,000 characters are passed in, an ArgumentOutOfRange exception is thrown. + * @param options Optional. An object literal that contains one or more of the following properties. + * asyncContext: Developers can provide any object they wish to access in the callback method. + * coercionType: If text, the current style is applied in Outlook Web App and Outlook. If the field is an HTML editor, only the text data is inserted, even if the data is HTML. If html and the field supports HTML (the subject doesn't), the current style is applied in Outlook Web App and the default style is applied in Outlook. If the field is a text field, an InvalidDataFormat error is returned. If coercionType is not set, the result depends on the field: if the field is HTML then HTML is used; if the field is text, then plain text is used. + * @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of type AsyncResult. If removing the attachment fails, the asyncResult.error property will contain an error code with the reason for the failure. + */ + setSelectedDataAsync(data: string, options?: AsyncContextOptions & CoercionTypeOptions, callback?: (result: AsyncResult) => void): void; + /** + * Asynchronously inserts data into the body or subject of a message. + * + * The setSelectedDataAsync method inserts the specified string at the cursor location in the subject or body of the item, or, if text is selected in the editor, it replaces the selected text. If the cursor is not in the body or subject field, an error is returned. After insertion, the cursor is placed at the end of the inserted content. + * + * [Api set: Mailbox 1.2] + * + * @remarks + * + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadWriteItem + * + * Applicable Outlook mode: Appointment Organizer + * + * Errors: InvalidAttachmentId - The attachment identifier does not exist. + * + * @param data The data to be inserted. Data is not to exceed 1,000,000 characters. If more than 1,000,000 characters are passed in, an ArgumentOutOfRange exception is thrown. + */ + setSelectedDataAsync(data: string): void; + /** + * Asynchronously inserts data into the body or subject of a message. + * + * The setSelectedDataAsync method inserts the specified string at the cursor location in the subject or body of the item, or, if text is selected in the editor, it replaces the selected text. If the cursor is not in the body or subject field, an error is returned. After insertion, the cursor is placed at the end of the inserted content. + * + * [Api set: Mailbox 1.2] + * + * @remarks + * + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadWriteItem + * + * Applicable Outlook mode: Appointment Organizer + * + * Errors: InvalidAttachmentId - The attachment identifier does not exist. + * + * @param data The data to be inserted. Data is not to exceed 1,000,000 characters. If more than 1,000,000 characters are passed in, an ArgumentOutOfRange exception is thrown. + * @param options Optional. An object literal that contains one or more of the following properties. + * asyncContext: Developers can provide any object they wish to access in the callback method. + * coercionType: If text, the current style is applied in Outlook Web App and Outlook. If the field is an HTML editor, only the text data is inserted, even if the data is HTML. If html and the field supports HTML (the subject doesn't), the current style is applied in Outlook Web App and the default style is applied in Outlook. If the field is a text field, an InvalidDataFormat error is returned. If coercionType is not set, the result depends on the field: if the field is HTML then HTML is used; if the field is text, then plain text is used. + */ + setSelectedDataAsync(data: string, options: AsyncContextOptions & CoercionTypeOptions): void; + /** + * Asynchronously inserts data into the body or subject of a message. + * + * The setSelectedDataAsync method inserts the specified string at the cursor location in the subject or body of the item, or, if text is selected in the editor, it replaces the selected text. If the cursor is not in the body or subject field, an error is returned. After insertion, the cursor is placed at the end of the inserted content. + * + * [Api set: Mailbox 1.2] + * + * @remarks + * + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadWriteItem + * + * Applicable Outlook mode: Appointment Organizer + * + * Errors: InvalidAttachmentId - The attachment identifier does not exist. + * + * @param data The data to be inserted. Data is not to exceed 1,000,000 characters. If more than 1,000,000 characters are passed in, an ArgumentOutOfRange exception is thrown. + * @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of type AsyncResult. If removing the attachment fails, the asyncResult.error property will contain an error code with the reason for the failure. + */ + setSelectedDataAsync(data: string, callback: (result: AsyncResult) => void): void; } /** - * Important: This is an internal Outlook object, not directly exposed through existing interfaces. You should treat this as a mode of Office.context.mailbox.item. Refer to the Object Model pages for more information. + * The appointment attendee mode of {@link Office.Item | Office.context.mailbox.item}. + * + * Important: This is an internal Outlook object, not directly exposed through existing interfaces. You should treat this as a mode of **Office.context.mailbox.item**. Refer to the Object Model pages for more information. */ interface AppointmentRead extends Appointment, ItemRead { /** * Gets the date and time that the appointment is to end. * - * The end property is expressed as a Coordinated Universal Time (UTC) date and time value. You can use the convertToLocalClientTime method to convert the end property value to the client's local date and time. - * - * The end property returns a Date object. + * The end property is a Date object expressed as a Coordinated Universal Time (UTC) date and time value. You can use the convertToLocalClientTime method to convert the end property value to the client's local date and time. * * When you use the Time.setAsync method to set the end time, you should use the convertToUtcClientTime method to convert the local time on the client to UTC for the server. * @@ -6608,7 +7446,7 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadItem * - * Applicable Outlook mode: Compose or read + * Applicable Outlook mode: Appointment Attendee */ end: Date; /** @@ -6622,13 +7460,13 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadItem * - * Applicable Outlook mode: Compose or read + * Applicable Outlook mode: Appointment Attendee */ location: string; /** * Provides access to the optional attendees of an event. The type of object and level of access depends on the mode of the current item. * - * The optionalAttendees property returns an array that contains an EmailAddressDetails object for each optional attendee to the meeting. + * The optionalAttendees property returns an array that contains an {@link Office.EmailAddressDetails} object for each optional attendee to the meeting. * * [Api set: Mailbox 1.0] * @@ -6636,7 +7474,7 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadItem * - * Applicable Outlook mode: Compose or read + * Applicable Outlook mode: Appointment Attendee */ optionalAttendees: EmailAddressDetails[]; /** @@ -6648,13 +7486,13 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadItem * - * Applicable Outlook mode: Read + * Applicable Outlook mode: Appointment Attendee */ organizer: EmailAddressDetails; /** * Provides access to the required attendees of an event. The type of object and level of access depends on the mode of the current item. * - * The requiredAttendees property returns an array that contains an EmailAddressDetails object for each required attendee to the meeting. + * The requiredAttendees property returns an array that contains an {@link Office.EmailAddressDetails} object for each required attendee to the meeting. * * [Api set: Mailbox 1.0] * @@ -6662,15 +7500,13 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadItem * - * Applicable Outlook mode: Compose or read + * Applicable Outlook mode: Appointment Attendee */ requiredAttendees: EmailAddressDetails[]; /** * Gets the date and time that the appointment is to begin. * - * The start property is expressed as a Coordinated Universal Time (UTC) date and time value. You can use the convertToLocalClientTime method to convert the value to the client's local date and time. - * - * The start property returns a Date object. + * The start property is a Date object expressed as a Coordinated Universal Time (UTC) date and time value. You can use the convertToLocalClientTime method to convert the value to the client's local date and time. * * [Api set: Mailbox 1.0] * @@ -6678,9 +7514,536 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadItem * - * Applicable Outlook mode: Compose or read + * Applicable Outlook mode: Appointment Attendee */ start: Date; + + // Repeated Item Fields // + + /** + * Gets an object that provides methods for manipulating the body of an item. + * + * [Api set: Mailbox 1.1] + * + * @remarks + * + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadItem + * + * Applicable Outlook mode: Appointment Attendee + */ + body: Body; + /** + * Gets the date and time that an item was created. Read mode only. + * + * [Api set: Mailbox 1.0] + * + * @remarks + * + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadItem + * + * Applicable Outlook mode: Appointment Attendee + */ + dateTimeCreated: Date; + /** + * Gets the date and time that an item was last modified. Read mode only. + * + * [Api set: Mailbox 1.0] + * + * @remarks + * + * Note: This member is not supported in Outlook for iOS or Outlook for Android. + * + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadItem + * + * Applicable Outlook mode: Appointment Attendee + */ + dateTimeModifed: Date; + /** + * Gets the type of item that an instance represents. + * + * The itemType property returns one of the ItemType enumeration values, indicating whether the item object instance is a message or an appointment. + * + * [Api set: Mailbox 1.0] + * + * @remarks + * + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadItem + * + * Applicable Outlook mode: Appointment Attendee + */ + itemType: Office.MailboxEnums.ItemType; + /** + * Gets the notification messages for an item. + * + * [Api set: Mailbox 1.3] + * + * @remarks + * + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadItem + * + * Applicable Outlook mode: Appointment Attendee + */ + notificationMessages: NotificationMessages; + + /** + * Gets the recurrence pattern of an appointment. Gets the recurrence pattern of a meeting request. + * + * The recurrence property returns a recurrence object for recurring appointments or meetings requests if an item is a series or an instance in a series. null is returned for single appointments and meeting requests of single appointments. + * + * Note: Meeting requests have an itemClass value of IPM.Schedule.Meeting.Request. + * + * Note: If the recurrence object is null, this indicates that the object is a single appointment or a meeting request of a single appointment and NOT a part of a series. + * + * [Api set: Mailbox Preview] + * + * @remarks + * + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadItem + * + * Applicable Outlook mode: Appointment Attendee + */ + recurrence: Recurrence; + + /** + * Gets the id of the series that an instance belongs to. + * + * In OWA and Outlook, the seriesId returns the Exchange Web Services (EWS) ID of the parent (series) item that this item belongs to. However, in iOS and Android, the seriesId returns the REST ID of the parent item. + * + * Note: The identifier returned by the seriesId property is the same as the Exchange Web Services item identifier. The seriesId property is not identical to the Outlook IDs used by the Outlook REST API. Before making REST API calls using this value, it should be converted using Office.context.mailbox.convertToRestId. For more details, see {@link https://docs.microsoft.com/outlook/add-ins/use-rest-api | Use the Outlook REST APIs from an Outlook add-in}. + * + * The seriesId property returns null for items that do not have parent items such as single appointments, series items, or meeting requests and returns undefined for any other items that are not meeting requests. + * + * [Api set: Mailbox Preview] + * + * @remarks + * + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadItem + * + * Applicable Outlook mode: Appointment Attendee + */ + seriesId: string; + + /** + * Adds an event handler for a supported event. + * + * Currently the only supported event type is Office.EventType.RecurrencePatternChanged, which is invoked when the user changes the recurrence pattern of a series. + * + * [Api set: Mailbox Preview] + * + * @remarks + * + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadItem + * + * Applicable Outlook mode: Appointment Attendee + * + * In addition to this signature, the method also has the following signatures: + * + * addHandlerAsync(eventType:EventType, handler: any, callback?: (result: AsyncResult) => void): void; + * + * @param eventType The event that should invoke the handler. + * @param handler The function to handle the event. The function must accept a single parameter, which is an object literal. The type property on the parameter will match the eventType parameter passed to addHandlerAsync. + * @param options Optional. An object literal that contains one or more of the following properties. + * asyncContext: Developers can provide any object they wish to access in the callback method. + * @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter, asyncResult, which is an AsyncResult object. + */ + addHandlerAsync(eventType:EventType, handler: any, options?: any, callback?: (result: AsyncResult) => void): void; + + /** + * Adds an event handler for a supported event. + * + * Currently the only supported event type is Office.EventType.RecurrencePatternChanged, which is invoked when the user changes the recurrence pattern of a series. + * + * [Api set: Mailbox Preview] + * + * @remarks + * + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadItem + * + * Applicable Outlook mode: Appointment Attendee + * + * @param eventType The event that should invoke the handler. + * @param handler The function to handle the event. The function must accept a single parameter, which is an object literal. The type property on the parameter will match the eventType parameter passed to addHandlerAsync. + * @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter, asyncResult, which is an AsyncResult object. + */ + addHandlerAsync(eventType:EventType, handler: any, callback?: (result: AsyncResult) => void): void; + + /** + * Asynchronously loads custom properties for this add-in on the selected item. + * + * Custom properties are stored as key/value pairs on a per-app, per-item basis. This method returns a CustomProperties object in the callback, which provides methods to access the custom properties specific to the current item and the current add-in. Custom properties are not encrypted on the item, so this should not be used as secure storage. + * + * The custom properties are provided as a CustomProperties object in the asyncResult.value property. This object can be used to get, set, and remove custom properties from the item and save changes to the custom property set back to the server. + * + * [Api set: Mailbox 1.0] + * + * @remarks + * + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadItem + * + * Applicable Outlook mode: Appointment Attendee + * + * @param callback When the method completes, the function passed in the callback parameter is called with a single parameter of type AsyncResult. + * @param userContext Optional. Developers can provide any object they wish to access in the callback function. This object can be accessed by the asyncResult.asyncContext property in the callback function. + */ + loadCustomPropertiesAsync(callback: (result: AsyncResult) => void, userContext?: any): void; + + /** + * Removes an event handler for a supported event. + * + * Currently the only supported event type is Office.EventType.RecurrencePatternChanged, which is invoked when the user changes the recurrence pattern of a series. + * + * [Api set: Mailbox Preview] + * + * @remarks + * + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadItem + * + * Applicable Outlook mode: Appointment Attendee + * + * In addition to this signature, the method also has the following signatures: + * + * removeHandlerAsync(eventType:EventType, handler: any, callback?: (result: AsyncResult) => void): void; + * + * @param eventType The event that should invoke the handler. + * @param handler The function to handle the event. The function must accept a single parameter, which is an object literal. The type property on the parameter will match the eventType parameter passed to removeHandlerAsync. + * @param options Optional. An object literal that contains one or more of the following properties. + * asyncContext: Developers can provide any object they wish to access in the callback method. + * @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter, asyncResult, which is an AsyncResult object. + */ + removeHandlerAsync(eventType:EventType, handler: any, options?: any, callback?: (result: AsyncResult) => void): void; + + /** + * Removes an event handler for a supported event. + * + * Currently the only supported event type is Office.EventType.RecurrencePatternChanged, which is invoked when the user changes the recurrence pattern of a series. + * + * [Api set: Mailbox Preview] + * + * @remarks + * + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadItem + * + * Applicable Outlook mode: Appointment Attendee + * + * @param eventType The event that should invoke the handler. + * @param handler The function to handle the event. The function must accept a single parameter, which is an object literal. The type property on the parameter will match the eventType parameter passed to removeHandlerAsync. + * @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter, asyncResult, which is an AsyncResult object. + */ + removeHandlerAsync(eventType:EventType, handler: any, callback?: (result: AsyncResult) => void): void; + + /** + * Gets an array of attachments for the item. + * + * [Api set: Mailbox 1.0] + * + * @remarks + * + * Note: Certain types of files are blocked by Outlook due to potential security issues and are therefore not returned. For more information, see {@link https://support.office.com/article/Blocked-attachments-in-Outlook-434752E1-02D3-4E90-9124-8B81E49A8519 | Blocked attachments in Outlook}. + * + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadItem + * + * Applicable Outlook mode: Appointment Attendee + * + */ + attachments: AttachmentDetails[]; + /** + * Gets the Exchange Web Services item class of the selected item. + * + + * + * You can create custom message classes that extends a default message class, for example, a custom appointment message class IPM.Appointment.Contoso. + * + * [Api set: Mailbox 1.0] + * + * @remarks + * + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadItem + * + * Applicable Outlook mode: Appointment Attendee + * + * The itemClass property specifies the message class of the selected item. The following are the default message classes for the message or appointment item. + * + * |Type|Description|item class| + * |-----------|------------|------------| + * |Appointment items|These are calendar items of the item class IPM.Appointment or IPM.Appointment.Occurence.|IPM.Appointment,IPM.Appointment.Occurence| + * |Message items|These include email messages that have the default message class IPM.Note, and meeting requests, responses, and cancellations, that use IPM.Schedule.Meeting as the base message class.|IPM.Note,IPM.Schedule.Meeting.Request,IPM.Schedule.Meeting.Neg,IPM.Schedule.Meeting.Pos,IPM.Schedule.Meeting.Tent,IPM.Schedule.Meeting.Canceled| + */ + itemClass: string; + /** + * Gets the Exchange Web Services item identifier for the current item. + * + * The itemId property is not available in compose mode. If an item identifier is required, the saveAsync method can be used to save the item to the store, which will return the item identifier in the AsyncResult.value parameter in the callback function. + * + * Note: The identifier returned by the itemId property is the same as the Exchange Web Services item identifier. The itemId property is not identical to the Outlook Entry ID or the ID used by the Outlook REST API. Before making REST API calls using this value, it should be converted using Office.context.mailbox.convertToRestId. For more details, see Use the Outlook REST APIs from an Outlook add-in. + * + * [Api set: Mailbox 1.0] + * + * @remarks + * + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadItem + * + * Applicable Outlook mode: Appointment Attendee + */ + itemId: string; + /** + * Gets the subject of an item, with all prefixes removed (including RE: and FWD:). + * + * The normalizedSubject property gets the subject of the item, with any standard prefixes (such as RE: and FW:) that are added by email programs. To get the subject of the item with the prefixes intact, use the subject property. + * + * [Api set: Mailbox 1.0] + * + * @remarks + * + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadItem + * + * Applicable Outlook mode: Appointment Attendee + */ + normalizedSubject: string; + /** + * Gets the description that appears in the subject field of an item. + * + * The subject property gets or sets the entire subject of the item, as sent by the email server. + * + * The subject property returns a string. Use the normalizedSubject property to get the subject minus any leading prefixes such as RE: and FW:. + * + * [Api set: Mailbox 1.0] + * + * @remarks + * + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadItem + * + * Applicable Outlook mode: Appointment Attendee + */ + subject: string; + /** + * Displays a reply form that includes the sender and all recipients of the selected message or the organizer and all attendees of the selected appointment. + * + * In Outlook Web App, the reply form is displayed as a pop-out form in the 3-column view and a pop-up form in the 2- or 1-column view. + * + * If any of the string parameters exceed their limits, displayReplyAllForm throws an exception. + * + * When attachments are specified in the formData.attachments parameter, Outlook and Outlook Web App attempt to download all attachments and attach them to the reply form. If any attachments fail to be added, an error is shown in the form UI. If this isn't possible, then no error message is thrown. + * + * Note: This method is not supported in Outlook for iOS or Outlook for Android. + * + * [Api set: Mailbox 1.0] + * + * @remarks + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadItem + * + * Applicable Outlook mode: Appointment Attendee + * + * @param formData A string that contains text and HTML and that represents the body of the reply form. The string is limited to 32 KB + * OR + * An {@link Office.ReplyFormData} object that contains body or attachment data and a callback function + */ + displayReplyAllForm(formData: string | ReplyFormData): void; + /** + * Displays a reply form that includes only the sender of the selected message or the organizer of the selected appointment. + * + * In Outlook Web App, the reply form is displayed as a pop-out form in the 3-column view and a pop-up form in the 2- or 1-column view. + * + * If any of the string parameters exceed their limits, displayReplyForm throws an exception. + * + * When attachments are specified in the formData.attachments parameter, Outlook and Outlook Web App attempt to download all attachments and attach them to the reply form. If any attachments fail to be added, an error is shown in the form UI. If this isn't possible, then no error message is thrown. + * + * Note: This method is not supported in Outlook for iOS or Outlook for Android. + * + * [Api set: Mailbox 1.0] + * + * @remarks + * + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadItem + * + * Applicable Outlook mode: Appointment Attendee + * + * @param formData A string that contains text and HTML and that represents the body of the reply form. The string is limited to 32 KB. + * OR + * An {@link Office.ReplyFormData} object that contains body or attachment data and a callback function. + */ + displayReplyForm(formData: string | ReplyFormData): void; + /** + * Gets initialization data passed when the add-in is {@link https://docs.microsoft.com/outlook/actionable-messages/invoke-add-in-from-actionable-message | activated by an actionable message}. + * + * Note: This method is only supported by Outlook 2016 for Windows (Click-to-Run versions greater than 16.0.8413.1000) and Outlook on the web for Office 365. + * + * [Api set: Mailbox Preview] + * + * @remarks + * + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadItem + * + * Applicable Outlook mode: Appointment Attendee + * + * In addition to this signature, the method also has the following signatures: + * + * getInitializationContextAsync(callback?: (result: AsyncResult) => void): void; + * + * @param options Optional. An object literal that contains one or more of the following properties. + * asyncContext: Developers can provide any object they wish to access in the callback method. + * @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter, asyncResult, which is an AsyncResult object. On success, the initialization data is provided in the asyncResult.value property as a string. If there is no initialization context, the asyncResult object will contain an Error object with its code property set to 9020 and its name property set to GenericResponseError. + */ + getInitializationContextAsync(options?: AsyncContextOptions, callback?: (result: AsyncResult) => void): void; + /** + * Gets initialization data passed when the add-in is {@link https://docs.microsoft.com/outlook/actionable-messages/invoke-add-in-from-actionable-message | activated by an actionable message}. + * + * Note: This method is only supported by Outlook 2016 for Windows (Click-to-Run versions greater than 16.0.8413.1000) and Outlook on the web for Office 365. + * + * [Api set: Mailbox Preview] + * + * @remarks + * + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadItem + * + * Applicable Outlook mode: Appointment Attendee + * + * @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter, asyncResult, which is an AsyncResult object. On success, the initialization data is provided in the asyncResult.value property as a string. If there is no initialization context, the asyncResult object will contain an Error object with its code property set to 9020 and its name property set to GenericResponseError. + */ + getInitializationContextAsync(callback?: (result: AsyncResult) => void): void; + /** + * Gets the entities found in the selected item. + * + * Note: This method is not supported in Outlook for iOS or Outlook for Android. + * + * [Api set: Mailbox 1.0] + * + * @remarks + * + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadItem + * + * Applicable Outlook mode: Appointment Attendee + */ + getEntities(): Entities; + /** + * Gets an array of all the entities of the specified entity type found in the selected item. + * + * Note: This method is not supported in Outlook for iOS or Outlook for Android. + * + * [Api set: Mailbox 1.0] + * + * @param entityType One of the EntityType enumeration values. + * + * @returns + * If the value passed in entityType is not a valid member of the EntityType enumeration, the method returns null. If no entities of the specified type are present on the item, the method returns an empty array. Otherwise, the type of the objects in the returned array depends on the type of entity requested in the entityType parameter. + * + * @remarks + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: Restricted + * + * Applicable Outlook mode: Appointment Attendee + * + * While the minimum permission level to use this method is Restricted, some entity types require ReadItem to access, as specified in the following table. + * + * |Value of entityType|Type of objects in returned array|Required Permission Level| + * |-------|-----------|----------| + * |Address|String|Restricted| + * |Contact|Contact|ReadItem| + * |EmailAddress|String|ReadItem| + * |MeetingSuggestion|MeetingSuggestion|ReadItem| + * |PhoneNumber|PhoneNumber|Restricted| + * |TaskSuggestion|TaskSuggestion|ReadItem| + * |URL|String|Restricted| + */ + getEntitiesByType(entityType: Office.MailboxEnums.EntityType): (string | Contact | MeetingSuggestion | PhoneNumber | TaskSuggestion)[]; + /** + * Returns well-known entities in the selected item that pass the named filter defined in the manifest XML file. + * + * The getFilteredEntitiesByName method returns the entities that match the regular expression defined in the ItemHasKnownEntity rule element in the manifest XML file with the specified FilterName element value. + * + * Note: This method is not supported in Outlook for iOS or Outlook for Android. + * + * [Api set: Mailbox 1.0] + * + * @remarks + * + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadItem + * + * Applicable Outlook mode: Appointment Attendee + * + * @param name The name of the ItemHasKnownEntity rule element that defines the filter to match. + * @returns If there is no ItemHasKnownEntity element in the manifest with a FilterName element value that matches the name parameter, the method returns null. If the name parameter does match an ItemHasKnownEntity element in the manifest, but there are no entities in the current item that match, the method return an empty array. + */ + getFilteredEntitiesByName(name: string): (string | Contact | MeetingSuggestion | PhoneNumber | TaskSuggestion)[]; + /** + * Returns string values in the selected item that match the regular expressions defined in the manifest XML file. + * + * The getRegExMatches method returns the strings that match the regular expression defined in each ItemHasRegularExpressionMatch or ItemHasKnownEntity rule element in the manifest XML file. For an ItemHasRegularExpressionMatch rule, a matching string has to occur in the property of the item that is specified by that rule. The PropertyName simple type defines the supported properties. + * + * If you specify an ItemHasRegularExpressionMatch rule on the body property of an item, the regular expression should further filter the body and should not attempt to return the entire body of the item. Using a regular expression such as .* to obtain the entire body of an item does not always return the expected results. Instead, use the Body.getAsync method to retrieve the entire body. + * + * Note: This method is not supported in Outlook for iOS or Outlook for Android. + * + * [Api set: Mailbox 1.0] + * + * @returns + * An object that contains arrays of strings that match the regular expressions defined in the manifest XML file. The name of each array is equal to the corresponding value of the RegExName attribute of the matching ItemHasRegularExpressionMatch rule or the FilterName attribute of the matching ItemHasKnownEntity rule. + * + * @remarks + * + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadItem + * + * Applicable Outlook mode: Appointment Attendee + */ + getRegExMatches(): any; + /** + * Returns string values in the selected item that match the named regular expression defined in the manifest XML file. + * + * The getRegExMatchesByName method returns the strings that match the regular expression defined in the ItemHasRegularExpressionMatch rule element in the manifest XML file with the specified RegExName element value. + * + * If you specify an ItemHasRegularExpressionMatch rule on the body property of an item, the regular expression should further filter the body and should not attempt to return the entire body of the item. Using a regular expression such as .* to obtain the entire body of an item does not always return the expected results. + * + * Note: This method is not supported in Outlook for iOS or Outlook for Android. + * + * [Api set: Mailbox 1.0] + * + * @returns + * An array that contains the strings that match the regular expression defined in the manifest XML file. + * + * @remarks + * + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadItem + * + * Applicable Outlook mode: Appointment Attendee + * + * @param name The name of the ItemHasRegularExpressionMatch rule element that defines the filter to match. + */ + getRegExMatchesByName(name: string): string[]; + /** + * Gets the entities found in a highlighted match a user has selected. Highlighted matches apply to contextual add-ins. + * + * Note: This method is not supported in Outlook for iOS or Outlook for Android. + * + * [Api set: Mailbox 1.6] + * + * @remarks + * + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadItem + * + * Applicable Outlook mode: Appointment Attendee + * + * @param name The name of the ItemHasRegularExpressionMatch rule element that defines the filter to match. + */ + getSelectedEntities(): Entities; + /** + * Returns string values in a highlighted match that match the regular expressions defined in the manifest XML file. Highlighted matches apply to contextual add-ins. + * + * The getSelectedRegExMatches method returns the strings that match the regular expression defined in each ItemHasRegularExpressionMatch or ItemHasKnownEntity rule element in the manifest XML file. For an ItemHasRegularExpressionMatch rule, a matching string has to occur in the property of the item that is specified by that rule. The PropertyName simple type defines the supported properties. + * + * If you specify an ItemHasRegularExpressionMatch rule on the body property of an item, the regular expression should further filter the body and should not attempt to return the entire body of the item. Using a regular expression such as .* to obtain the entire body of an item does not always return the expected results. Instead, use the Body.getAsync method to retrieve the entire body. + * + * Note: This method is not supported in Outlook for iOS or Outlook for Android. + * + * [Api set: Mailbox 1.6] + * + * @returns + * An object that contains arrays of strings that match the regular expressions defined in the manifest XML file. The name of each array is equal to the corresponding value of the RegExName attribute of the matching ItemHasRegularExpressionMatch rule or the FilterName attribute of the matching ItemHasKnownEntity rule. + * + * @remarks + * + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadItem + * + * Applicable Outlook mode: Appointment Attendee + */ + getSelectedRegExMatches(): any; } interface AppointmentForm { @@ -6829,7 +8192,7 @@ declare namespace Office { } /** - * The item namespace is used to access the currently selected message, meeting request, or appointment. You can determine the type of the item by using the itemType property. + * The item namespace is used to access the currently selected message, meeting request, or appointment. You can determine the type of the item by using the `itemType` property. * * [Api set: Mailbox 1.0] * @@ -6956,6 +8319,7 @@ declare namespace Office { * Applicable Outlook mode: Compose or read * * In addition to this signature, the method also has the following signatures: + * * addHandlerAsync(eventType:EventType, handler: any, callback?: (result: AsyncResult) => void): void; * * @param eventType The event that should invoke the handler. @@ -7019,6 +8383,7 @@ declare namespace Office { * Applicable Outlook mode: Compose or read * * In addition to this signature, the method also has the following signatures: + * * removeHandlerAsync(eventType:EventType, handler: any, callback?: (result: AsyncResult) => void): void; * * @param eventType The event that should invoke the handler. @@ -7049,7 +8414,9 @@ declare namespace Office { removeHandlerAsync(eventType:EventType, handler: any, callback?: (result: AsyncResult) => void): void; } /** - * Important: This is an internal Outlook object, not directly exposed through existing interfaces. You should treat this as a mode of Office.context.mailbox.item. Refer to the Object Model pages for more information. + * The compose mode of {@link Office.Item | Office.context.mailbox.item}. + * + * Important: This is an internal Outlook object, not directly exposed through existing interfaces. You should treat this as a mode of **Office.context.mailbox.item**. Refer to the Object Model pages for more information. */ interface ItemCompose extends Item { /** @@ -7091,8 +8458,11 @@ declare namespace Office { * NumberOfAttachmentsExceeded - The message or appointment has too many attachments. * * In addition to this signature, the method also has the following signatures: + * * addFileAttachmentAsync(uri: string, attachmentName: string): void; + * * addFileAttachmentAsync(uri: string, attachmentName: string, options: AsyncContextOptions): void; + * * addFileAttachmentAsync(uri: string, attachmentName: string, callback: (result: AsyncResult) => void): void; * * @param uri The URI that provides the location of the file to attach to the message or appointment. The maximum length is 2048 characters. @@ -7207,8 +8577,11 @@ declare namespace Office { * NumberOfAttachmentsExceeded - The message or appointment has too many attachments. * * In addition to the main signature, this method also has these signatures: + * * addItemAttachmentAsync(itemId: any, attachmentName: string): void; + * * addItemAttachmentAsync(itemId: any, attachmentName: string, options: AsyncContextOptions): void; + * * addItemAttachmentAsync(itemId: any, attachmentName: string, callback: (result: AsyncResult) => void): void; * * @param itemId The Exchange identifier of the item to attach. The maximum length is 100 characters. @@ -7332,34 +8705,7 @@ declare namespace Office { * @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of type AsyncResult. On success, the initialization data is provided in the asyncResult.value property as a string. If there is no initialization context, the asyncResult object will contain an Error object with its code property set to 9020 and its name property set to GenericResponseError. */ getInitializationContextAsync(options?: AsyncContextOptions, callback?: (result: AsyncResult) => void): void; - /** - * Asynchronously returns selected data from the subject or body of a message. - * - * If there is no selection but the cursor is in the body or subject, the method returns null for the selected data. If a field other than the body or subject is selected, the method returns the InvalidSelection error. - * - * To access the selected data from the callback method, call asyncResult.value.data. To access the source property that the selection comes from, call asyncResult.value.sourceProperty, which will be either body or subject. - * - * [Api set: Mailbox 1.0] - * - * @returns - * The selected data as a string with format determined by coercionType. - * - * @remarks - * - * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadWriteItem - * - * Applicable Outlook mode: Compose - * - * In addition to this signature, the method also has these signatures: - * getSelectedDataAsync(coercionType: CoercionType, callback: (result: AsyncResult) => void): void; - * - * @param coercionType Requests a format for the data. If Text, the method returns the plain text as a string , removing any HTML tags present. If HTML, the method returns the selected text, whether it is plaintext or HTML. - * @param options An object literal that contains one or more of the following properties. - * asyncContext: Developers can provide any object they wish to access in the callback method. - * @param callback When the method completes, the function passed in the callback parameter is called with a single parameter of type AsyncResult. - */ - getSelectedDataAsync(coercionType: CoercionType, options: AsyncContextOptions, callback: (result: AsyncResult) => void): void; - /** + /** * Asynchronously returns selected data from the subject or body of a message. * * If there is no selection but the cursor is in the body or subject, the method returns null for the selected data. If a field other than the body or subject is selected, the method returns the InvalidSelection error. @@ -7381,6 +8727,30 @@ declare namespace Office { * @param callback When the method completes, the function passed in the callback parameter is called with a single parameter of type AsyncResult. */ getSelectedDataAsync(coercionType: CoercionType, callback: (result: AsyncResult) => void): void; + /** + * Asynchronously returns selected data from the subject or body of a message. + * + * If there is no selection but the cursor is in the body or subject, the method returns null for the selected data. If a field other than the body or subject is selected, the method returns the InvalidSelection error. + * + * To access the selected data from the callback method, call asyncResult.value.data. To access the source property that the selection comes from, call asyncResult.value.sourceProperty, which will be either body or subject. + * + * [Api set: Mailbox 1.0] + * + * @returns + * The selected data as a string with format determined by coercionType. + * + * @remarks + * + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadWriteItem + * + * Applicable Outlook mode: Compose + * + * @param coercionType Requests a format for the data. If Text, the method returns the plain text as a string , removing any HTML tags present. If HTML, the method returns the selected text, whether it is plaintext or HTML. + * @param options An object literal that contains one or more of the following properties. + * asyncContext: Developers can provide any object they wish to access in the callback method. + * @param callback When the method completes, the function passed in the callback parameter is called with a single parameter of type AsyncResult. + */ + getSelectedDataAsync(coercionType: CoercionType, options: AsyncContextOptions, callback: (result: AsyncResult) => void): void; /** * Removes an attachment from a message or appointment. * @@ -7397,8 +8767,11 @@ declare namespace Office { * Errors: InvalidAttachmentId - The attachment identifier does not exist. * * In addition to this signature, the method also has the following signatures: + * * removeAttachmentAsync(attachmentIndex: string): void; + * * removeAttachmentAsync(attachmentIndex: string, options: AsyncContextOptions): void; + * * removeAttachmentAsync(attachmentIndex: string, callback: (result: AsyncResult) => void): void; * * @param attachmentIndex The identifier of the attachment to remove. The maximum length of the string is 100 characters. @@ -7491,8 +8864,11 @@ declare namespace Office { * Errors: InvalidAttachmentId - The attachment identifier does not exist. * * In addition to this signature, the method also has the following signatures: + * * saveAsync(): void; + * * saveAsync(options: AsyncContextOptions): void; + * * saveAsync(callback: (result: AsyncResult) => void): void; * * @param options Optional. An object literal that contains one or more of the following properties. @@ -7600,11 +8976,14 @@ declare namespace Office { * Errors: InvalidAttachmentId - The attachment identifier does not exist. * * In addition to this signature, the method also has the following signatures: + * * setSelectedDataAsync(data: string): void; + * * setSelectedDataAsync(data: string, options: AsyncContextOptions & CoercionTypeOptions): void; + * * setSelectedDataAsync(data: string, callback: (result: AsyncResult) => void): void; * - * @param data The data to be inserted. Data is not to exceed 1,000,000 characters. If more than 1,000,000 characters are passed in, an ArgumentOutOfRange exception is thrown. + * @param data The data to be inserted. Data is not to exceed 1,000,000 characters. If more than 1,000,000 characters are passed in, an ArgumentOutOfRange exception is thrown. * @param options Optional. An object literal that contains one or more of the following properties. * asyncContext: Developers can provide any object they wish to access in the callback method. * coercionType: If text, the current style is applied in Outlook Web App and Outlook. If the field is an HTML editor, only the text data is inserted, even if the data is HTML. If html and the field supports HTML (the subject doesn't), the current style is applied in Outlook Web App and the default style is applied in Outlook. If the field is a text field, an InvalidDataFormat error is returned. If coercionType is not set, the result depends on the field: if the field is HTML then HTML is used; if the field is text, then plain text is used. @@ -7671,11 +9050,13 @@ declare namespace Office { setSelectedDataAsync(data: string, callback: (result: AsyncResult) => void): void; } /** - * Important: This is an internal Outlook object, not directly exposed through existing interfaces. You should treat this as a mode of Office.context.mailbox.item. Refer to the Object Model pages for more information. + * The read mode of {@link Office.Item | Office.context.mailbox.item}. + * + * Important: This is an internal Outlook object, not directly exposed through existing interfaces. You should treat this as a mode of **Office.context.mailbox.item**. Refer to the Object Model pages for more information. */ interface ItemRead extends Item { /** - * Gets an array of attachments for the item. Read mode only. + * Gets an array of attachments for the item. * * [Api set: Mailbox 1.0] * @@ -7690,9 +9071,8 @@ declare namespace Office { */ attachments: AttachmentDetails[]; /** - * Gets the Exchange Web Services item class of the selected item. Read mode only. + * Gets the Exchange Web Services item class of the selected item. * - * The itemClass property specifies the message class of the selected item. The following are the default message classes for the message or appointment item. * * You can create custom message classes that extends a default message class, for example, a custom appointment message class IPM.Appointment.Contoso. * @@ -7700,18 +9080,20 @@ declare namespace Office { * * @remarks * - * |Type|Description|Item Class| - * |-----------|------------|------------| - * |Appointment items|These are calendar items of the item class IPM.Appointment or IPM.Appointment.Occurence.|IPM.Appointment,IPM.Appointment.Occurence| - * |Message items|These include email messages that have the default message class IPM.Note, and meeting requests, responses, and cancellations, that use IPM.Schedule.Meeting as the base message class.|IPM.Note,IPM.Schedule.Meeting.Request,IPM.Schedule.Meeting.Neg,IPM.Schedule.Meeting.Pos,IPM.Schedule.Meeting.Tent,IPM.Schedule.Meeting.Canceled| - * * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadItem * * Applicable Outlook mode: Read + * + * The itemClass property specifies the message class of the selected item. The following are the default message classes for the message or appointment item. + * + * |Type|Description|item class| + * |-----------|------------|------------| + * |Appointment items|These are calendar items of the item class IPM.Appointment or IPM.Appointment.Occurence.|IPM.Appointment,IPM.Appointment.Occurence| + * |Message items|These include email messages that have the default message class IPM.Note, and meeting requests, responses, and cancellations, that use IPM.Schedule.Meeting as the base message class.|IPM.Note,IPM.Schedule.Meeting.Request,IPM.Schedule.Meeting.Neg,IPM.Schedule.Meeting.Pos,IPM.Schedule.Meeting.Tent,IPM.Schedule.Meeting.Canceled| */ itemClass: string; /** - * Gets the Exchange Web Services item identifier for the current item. Read mode only. + * Gets the Exchange Web Services item identifier for the current item. * * The itemId property is not available in compose mode. If an item identifier is required, the saveAsync method can be used to save the item to the store, which will return the item identifier in the AsyncResult.value parameter in the callback function. * @@ -7727,7 +9109,7 @@ declare namespace Office { */ itemId: string; /** - * Gets the subject of an item, with all prefixes removed (including RE: and FWD:). Read mode only. + * Gets the subject of an item, with all prefixes removed (including RE: and FWD:). * * The normalizedSubject property gets the subject of the item, with any standard prefixes (such as RE: and FW:) that are added by email programs. To get the subject of the item with the prefixes intact, use the subject property. * @@ -7776,7 +9158,7 @@ declare namespace Office { * * @param formData A string that contains text and HTML and that represents the body of the reply form. The string is limited to 32 KB * OR - * A ReplyFormData object that contains body or attachment data and a callback function + * An {@link Office.ReplyFormData} object that contains body or attachment data and a callback function */ displayReplyAllForm(formData: string | ReplyFormData): void; /** @@ -7800,7 +9182,7 @@ declare namespace Office { * * @param formData A string that contains text and HTML and that represents the body of the reply form. The string is limited to 32 KB. * OR - * A ReplyFormData object that contains body or attachment data and a callback function. + * An {@link Office.ReplyFormData} object that contains body or attachment data and a callback function. */ displayReplyForm(formData: string | ReplyFormData): void; /** @@ -7817,6 +9199,7 @@ declare namespace Office { * Applicable Outlook mode: Read * * In addition to this signature, the method also has the following signatures: + * * getInitializationContextAsync(callback?: (result: AsyncResult) => void): void; * * @param options Optional. An object literal that contains one or more of the following properties. @@ -7860,11 +9243,16 @@ declare namespace Office { * Note: This method is not supported in Outlook for iOS or Outlook for Android. * * [Api set: Mailbox 1.0] + * + * @param entityType One of the EntityType enumeration values. * * @returns * If the value passed in entityType is not a valid member of the EntityType enumeration, the method returns null. If no entities of the specified type are present on the item, the method returns an empty array. Otherwise, the type of the objects in the returned array depends on the type of entity requested in the entityType parameter. * * @remarks + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: Restricted + * + * Applicable Outlook mode: Read * * While the minimum permission level to use this method is Restricted, some entity types require ReadItem to access, as specified in the following table. * @@ -7877,12 +9265,6 @@ declare namespace Office { * |PhoneNumber|PhoneNumber|Restricted| * |TaskSuggestion|TaskSuggestion|ReadItem| * |URL|String|Restricted| - * - * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: Restricted - * - * Applicable Outlook mode: Read - * - * @param entityType One of the EntityType enumeration values. */ getEntitiesByType(entityType: Office.MailboxEnums.EntityType): (string | Contact | MeetingSuggestion | PhoneNumber | TaskSuggestion)[]; /** @@ -7987,7 +9369,9 @@ declare namespace Office { getSelectedRegExMatches(): any; } /** - * Important: This is an internal Outlook object, not directly exposed through existing interfaces. You should treat this as a mode of Office.context.mailbox.item. Refer to the Object Model pages for more information. + * A subclass of {@link Office.Item} for messages. + * + * Important: This is an internal Outlook object, not directly exposed through existing interfaces. You should treat this as a mode of **Office.context.mailbox.item**. Refer to the Object Model pages for more information. */ interface Message extends Item { /** @@ -8009,11 +9393,13 @@ declare namespace Office { } /** - * Important: This is an internal Outlook object, not directly exposed through existing interfaces. You should treat this as a mode of Office.context.mailbox.item. Refer to the Object Model pages for more information. + * The message compose mode of {@link Office.Item | Office.context.mailbox.item}. + * + * Important: This is an internal Outlook object, not directly exposed through existing interfaces. You should treat this as a mode of **Office.context.mailbox.item**. Refer to the Object Model pages for more information. */ interface MessageCompose extends Message, ItemCompose { /** - * Gets an object that provides methods to get or update the recipients on the Bcc (blind carbon copy) line of a message. Compose mode only. + * Gets an object that provides methods to get or update the recipients on the Bcc (blind carbon copy) line of a message. * * [Api set: Mailbox 1.1] * @@ -8021,15 +9407,13 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadItem * - * Applicable Outlook mode: Compose + * Applicable Outlook mode: Message Compose */ bcc: Recipients; /** * Provides access to the Cc (carbon copy) recipients of a message. The type of object and level of access depends on the mode of the current item. * - * *Compose mode* - * - * The cc property returns a Recipients object that provides methods to get or update the recipients on the Cc line of the message. + * The cc property returns a {@link Office.Recipients} object that provides methods to get or update the recipients on the Cc line of the message. * * [Api set: Mailbox 1.0] * @@ -8037,7 +9421,7 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadItem * - * Applicable Outlook mode: Compose or read + * Applicable Outlook mode: Message Compose */ cc: Recipients; /** @@ -8053,7 +9437,7 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadItem * - * Applicable Outlook mode: Read + * Applicable Outlook mode: Message Compose */ from: From; /** @@ -8067,11 +9451,856 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadItem * - * Applicable Outlook mode: Compose or read + * Applicable Outlook mode: Message Compose */ to: Recipients; + + // Repeated Item Fields // + + /** + * Gets an object that provides methods for manipulating the body of an item. + * + * [Api set: Mailbox 1.1] + * + * @remarks + * + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadItem + * + * Applicable Outlook mode: Message Compose + */ + body: Body; + /** + * Gets the date and time that an item was created. Read mode only. + * + * [Api set: Mailbox 1.0] + * + * @remarks + * + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadItem + * + * Applicable Outlook mode: Message Compose + */ + dateTimeCreated: Date; + /** + * Gets the date and time that an item was last modified. Read mode only. + * + * [Api set: Mailbox 1.0] + * + * @remarks + * + * Note: This member is not supported in Outlook for iOS or Outlook for Android. + * + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadItem + * + * Applicable Outlook mode: Message Compose + */ + dateTimeModifed: Date; + /** + * Gets the type of item that an instance represents. + * + * The itemType property returns one of the ItemType enumeration values, indicating whether the item object instance is a message or an appointment. + * + * [Api set: Mailbox 1.0] + * + * @remarks + * + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadItem + * + * Applicable Outlook mode: Message Compose + */ + itemType: Office.MailboxEnums.ItemType; + /** + * Gets the notification messages for an item. + * + * [Api set: Mailbox 1.3] + * + * @remarks + * + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadItem + * + * Applicable Outlook mode: Message Compose + */ + notificationMessages: NotificationMessages; + + /** + * Gets or sets the recurrence pattern of an appointment. Gets the recurrence pattern of a meeting request. Read and compose modes for appointment items. Read mode for meeting request items. + * + * The recurrence property returns a recurrence object for recurring appointments or meetings requests if an item is a series or an instance in a series. null is returned for single appointments and meeting requests of single appointments. undefined is returned for messages that are not meeting requests. + * + * Note: Meeting requests have an itemClass value of IPM.Schedule.Meeting.Request. + * + * Note: If the recurrence object is null, this indicates that the object is a single appointment or a meeting request of a single appointment and NOT a part of a series. + * + * [Api set: Mailbox Preview] + * + * @remarks + * + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadItem + * + * Applicable Outlook mode: Message Compose + */ + recurrence: Recurrence; + + /** + * Gets the id of the series that an instance belongs to. + * + * In OWA and Outlook, the seriesId returns the Exchange Web Services (EWS) ID of the parent (series) item that this item belongs to. However, in iOS and Android, the seriesId returns the REST ID of the parent item. + * + * Note: The identifier returned by the seriesId property is the same as the Exchange Web Services item identifier. The seriesId property is not identical to the Outlook IDs used by the Outlook REST API. Before making REST API calls using this value, it should be converted using Office.context.mailbox.convertToRestId. For more details, see {@link https://docs.microsoft.com/outlook/add-ins/use-rest-api | Use the Outlook REST APIs from an Outlook add-in}. + * + * The seriesId property returns null for items that do not have parent items such as single appointments, series items, or meeting requests and returns undefined for any other items that are not meeting requests. + * + * [Api set: Mailbox Preview] + * + * @remarks + * + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadItem + * + * Applicable Outlook mode: Message Compose + */ + seriesId: string; + + /** + * Adds an event handler for a supported event. + * + * Currently the only supported event type is Office.EventType.RecurrencePatternChanged, which is invoked when the user changes the recurrence pattern of a series. + * + * [Api set: Mailbox Preview] + * + * @remarks + * + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadItem + * + * Applicable Outlook mode: Message Compose + * + * In addition to this signature, the method also has the following signatures: + * + * addHandlerAsync(eventType:EventType, handler: any, callback?: (result: AsyncResult) => void): void; + * + * @param eventType The event that should invoke the handler. + * @param handler The function to handle the event. The function must accept a single parameter, which is an object literal. The type property on the parameter will match the eventType parameter passed to addHandlerAsync. + * @param options Optional. An object literal that contains one or more of the following properties. + * asyncContext: Developers can provide any object they wish to access in the callback method. + * @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter, asyncResult, which is an AsyncResult object. + */ + addHandlerAsync(eventType:EventType, handler: any, options?: any, callback?: (result: AsyncResult) => void): void; + + /** + * Adds an event handler for a supported event. + * + * Currently the only supported event type is Office.EventType.RecurrencePatternChanged, which is invoked when the user changes the recurrence pattern of a series. + * + * [Api set: Mailbox Preview] + * + * @remarks + * + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadItem + * + * Applicable Outlook mode: Message Compose + * + * @param eventType The event that should invoke the handler. + * @param handler The function to handle the event. The function must accept a single parameter, which is an object literal. The type property on the parameter will match the eventType parameter passed to addHandlerAsync. + * @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter, asyncResult, which is an AsyncResult object. + */ + addHandlerAsync(eventType:EventType, handler: any, callback?: (result: AsyncResult) => void): void; + + /** + * Asynchronously loads custom properties for this add-in on the selected item. + * + * Custom properties are stored as key/value pairs on a per-app, per-item basis. This method returns a CustomProperties object in the callback, which provides methods to access the custom properties specific to the current item and the current add-in. Custom properties are not encrypted on the item, so this should not be used as secure storage. + * + * The custom properties are provided as a CustomProperties object in the asyncResult.value property. This object can be used to get, set, and remove custom properties from the item and save changes to the custom property set back to the server. + * + * [Api set: Mailbox 1.0] + * + * @remarks + * + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadItem + * + * Applicable Outlook mode: Message Compose + * + * @param callback When the method completes, the function passed in the callback parameter is called with a single parameter of type AsyncResult. + * @param userContext Optional. Developers can provide any object they wish to access in the callback function. This object can be accessed by the asyncResult.asyncContext property in the callback function. + */ + loadCustomPropertiesAsync(callback: (result: AsyncResult) => void, userContext?: any): void; + + /** + * Removes an event handler for a supported event. + * + * Currently the only supported event type is Office.EventType.RecurrencePatternChanged, which is invoked when the user changes the recurrence pattern of a series. + * + * [Api set: Mailbox Preview] + * + * @remarks + * + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadItem + * + * Applicable Outlook mode: Message Compose + * + * In addition to this signature, the method also has the following signatures: + * + * removeHandlerAsync(eventType:EventType, handler: any, callback?: (result: AsyncResult) => void): void; + * + * @param eventType The event that should invoke the handler. + * @param handler The function to handle the event. The function must accept a single parameter, which is an object literal. The type property on the parameter will match the eventType parameter passed to removeHandlerAsync. + * @param options Optional. An object literal that contains one or more of the following properties. + * asyncContext: Developers can provide any object they wish to access in the callback method. + * @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter, asyncResult, which is an AsyncResult object. + */ + removeHandlerAsync(eventType:EventType, handler: any, options?: any, callback?: (result: AsyncResult) => void): void; + + /** + * Removes an event handler for a supported event. + * + * Currently the only supported event type is Office.EventType.RecurrencePatternChanged, which is invoked when the user changes the recurrence pattern of a series. + * + * [Api set: Mailbox Preview] + * + * @remarks + * + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadItem + * + * Applicable Outlook mode: Message Compose + * + * @param eventType The event that should invoke the handler. + * @param handler The function to handle the event. The function must accept a single parameter, which is an object literal. The type property on the parameter will match the eventType parameter passed to removeHandlerAsync. + * @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter, asyncResult, which is an AsyncResult object. + */ + removeHandlerAsync(eventType:EventType, handler: any, callback?: (result: AsyncResult) => void): void; + + /** + * Gets or sets the description that appears in the subject field of an item. + * + * The subject property gets or sets the entire subject of the item, as sent by the email server. + * + * The subject property returns a Subject object that provides methods to get and set the subject. + * + * [Api set: Mailbox 1.0] + * + * @remarks + * + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadItem + * + * Applicable Outlook mode: Message Compose + */ + subject: Subject; + /** + * Adds a file to a message or appointment as an attachment. + * + * The addFileAttachmentAsync method uploads the file at the specified URI and attaches it to the item in the compose form. + * + * You can subsequently use the identifier with the removeAttachmentAsync method to remove the attachment in the same session. + * + * [Api set: Mailbox 1.1] + * + * @remarks + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadWriteItem + * + * Applicable Outlook mode: Message Compose + * + * Errors: + * + * AttachmentSizeExceeded - The attachment is larger than allowed. + * + * FileTypeNotSupported - The attachment has an extension that is not allowed. + * + * NumberOfAttachmentsExceeded - The message or appointment has too many attachments. + * + * In addition to this signature, the method also has the following signatures: + * + * addFileAttachmentAsync(uri: string, attachmentName: string): void; + * + * addFileAttachmentAsync(uri: string, attachmentName: string, options: AsyncContextOptions): void; + * + * addFileAttachmentAsync(uri: string, attachmentName: string, callback: (result: AsyncResult) => void): void; + * + * @param uri The URI that provides the location of the file to attach to the message or appointment. The maximum length is 2048 characters. + * @param attachmentName The name of the attachment that is shown while the attachment is uploading. The maximum length is 255 characters. + * @param options Optional. An object literal that contains one or more of the following properties. + * asyncContext: Developers can provide any object they wish to access in the callback method. + * inInline: If true, indicates that the attachment will be shown inline in the message body, and should not be displayed in the attachment list. + * @param callback When the method completes, the function passed in the callback parameter is called with a single parameter of type asyncResult. On success, the attachment identifier will be provided in the asyncResult.value property. If uploading the attachment fails, the asyncResult object will contain an Error object that provides a description of the error. + */ + addFileAttachmentAsync(uri: string, attachmentName: string, options?: AsyncContextOptions, callback?: (result: AsyncResult) => void): void; + /** + * Adds a file to a message or appointment as an attachment. + * + * The addFileAttachmentAsync method uploads the file at the specified URI and attaches it to the item in the compose form. + * + * You can subsequently use the identifier with the removeAttachmentAsync method to remove the attachment in the same session. + * + * [Api set: Mailbox 1.1] + * + * @remarks + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadWriteItem + * + * Applicable Outlook mode: Message Compose + * + * Errors: + * + * AttachmentSizeExceeded - The attachment is larger than allowed. + * + * FileTypeNotSupported - The attachment has an extension that is not allowed. + * + * NumberOfAttachmentsExceeded - The message or appointment has too many attachments. + * + * @param uri The URI that provides the location of the file to attach to the message or appointment. The maximum length is 2048 characters. + * @param attachmentName The name of the attachment that is shown while the attachment is uploading. The maximum length is 255 characters. + */ + addFileAttachmentAsync(uri: string, attachmentName: string): void; + /** + * Adds a file to a message or appointment as an attachment. + * + * The addFileAttachmentAsync method uploads the file at the specified URI and attaches it to the item in the compose form. + * + * You can subsequently use the identifier with the removeAttachmentAsync method to remove the attachment in the same session. + * + * [Api set: Mailbox 1.1] + * + * @remarks + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadWriteItem + * + * Applicable Outlook mode: Message Compose + * + * Errors: + * + * AttachmentSizeExceeded - The attachment is larger than allowed. + * + * FileTypeNotSupported - The attachment has an extension that is not allowed. + * + * NumberOfAttachmentsExceeded - The message or appointment has too many attachments. + * + * @param uri The URI that provides the location of the file to attach to the message or appointment. The maximum length is 2048 characters. + * @param attachmentName The name of the attachment that is shown while the attachment is uploading. The maximum length is 255 characters. + * @param options Optional. An object literal that contains one or more of the following properties. + * asyncContext: Developers can provide any object they wish to access in the callback method. + * inInline: If true, indicates that the attachment will be shown inline in the message body, and should not be displayed in the attachment list. + */ + addFileAttachmentAsync(uri: string, attachmentName: string, options: AsyncContextOptions): void; + /** + * Adds a file to a message or appointment as an attachment. + * + * The addFileAttachmentAsync method uploads the file at the specified URI and attaches it to the item in the compose form. + * + * You can subsequently use the identifier with the removeAttachmentAsync method to remove the attachment in the same session. + * + * [Api set: Mailbox 1.1] + * + * @remarks + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadWriteItem + * + * Applicable Outlook mode: Message Compose + * + * Errors: + * + * AttachmentSizeExceeded - The attachment is larger than allowed. + * + * FileTypeNotSupported - The attachment has an extension that is not allowed. + * + * NumberOfAttachmentsExceeded - The message or appointment has too many attachments. + * + * @param uri The URI that provides the location of the file to attach to the message or appointment. The maximum length is 2048 characters. + * @param attachmentName The name of the attachment that is shown while the attachment is uploading. The maximum length is 255 characters. + * @param callback When the method completes, the function passed in the callback parameter is called with a single parameter of type asyncResult. On success, the attachment identifier will be provided in the asyncResult.value property. If uploading the attachment fails, the asyncResult object will contain an Error object that provides a description of the error. + */ + addFileAttachmentAsync(uri: string, attachmentName: string, callback: (result: AsyncResult) => void): void; + + /** + * Adds an Exchange item, such as a message, as an attachment to the message or appointment. + * + * The addItemAttachmentAsync method attaches the item with the specified Exchange identifier to the item in the compose form. If you specify a callback method, the method is called with one parameter, asyncResult, which contains either the attachment identifier or a code that indicates any error that occurred while attaching the item. You can use the options parameter to pass state information to the callback method, if needed. + * + * You can subsequently use the identifier with the removeAttachmentAsync method to remove the attachment in the same session. + * + * If your Office add-in is running in Outlook Web App, the addItemAttachmentAsync method can attach items to items other than the item that you are editing; however, this is not supported and is not recommended. + * + * [Api set: Mailbox 1.1] + * + * @remarks + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadWriteItem + * + * Applicable Outlook mode: Message Compose + * + * Errors: + * + * NumberOfAttachmentsExceeded - The message or appointment has too many attachments. + * + * In addition to the main signature, this method also has these signatures: + * + * addItemAttachmentAsync(itemId: any, attachmentName: string): void; + * + * addItemAttachmentAsync(itemId: any, attachmentName: string, options: AsyncContextOptions): void; + * + * addItemAttachmentAsync(itemId: any, attachmentName: string, callback: (result: AsyncResult) => void): void; + * + * @param itemId The Exchange identifier of the item to attach. The maximum length is 100 characters. + * @param attachmentName The name of the attachment that is shown while the attachment is uploading. The maximum length is 255 characters. + * @param options An object literal that contains one or more of the following properties. + * asyncContext: Developers can provide any object they wish to access in the callback method. + * @param callback When the method completes, the function passed in the callback parameter is called with a single parameter of type AsyncResult. On success, the attachment identifier will be provided in the asyncResult.value property. If adding the attachment fails, the asyncResult object will contain an Error object that provides a description of the error. + */ + addItemAttachmentAsync(itemId: any, attachmentName: string, options?: AsyncContextOptions, callback?: (result: AsyncResult) => void): void; + /** + * Adds an Exchange item, such as a message, as an attachment to the message or appointment. + * + * The addItemAttachmentAsync method attaches the item with the specified Exchange identifier to the item in the compose form. If you specify a callback method, the method is called with one parameter, asyncResult, which contains either the attachment identifier or a code that indicates any error that occurred while attaching the item. You can use the options parameter to pass state information to the callback method, if needed. + * + * You can subsequently use the identifier with the removeAttachmentAsync method to remove the attachment in the same session. + * + * If your Office add-in is running in Outlook Web App, the addItemAttachmentAsync method can attach items to items other than the item that you are editing; however, this is not supported and is not recommended. + * + * [Api set: Mailbox 1.1] + * + * @remarks + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadWriteItem + * + * Applicable Outlook mode: Message Compose + * + * Errors: + * + * NumberOfAttachmentsExceeded - The message or appointment has too many attachments. + * + * @param itemId The Exchange identifier of the item to attach. The maximum length is 100 characters. + * @param attachmentName The name of the attachment that is shown while the attachment is uploading. The maximum length is 255 characters. + */ + addItemAttachmentAsync(itemId: any, attachmentName: string): void; + /** + * Adds an Exchange item, such as a message, as an attachment to the message or appointment. + * + * The addItemAttachmentAsync method attaches the item with the specified Exchange identifier to the item in the compose form. If you specify a callback method, the method is called with one parameter, asyncResult, which contains either the attachment identifier or a code that indicates any error that occurred while attaching the item. You can use the options parameter to pass state information to the callback method, if needed. + * + * You can subsequently use the identifier with the removeAttachmentAsync method to remove the attachment in the same session. + * + * If your Office add-in is running in Outlook Web App, the addItemAttachmentAsync method can attach items to items other than the item that you are editing; however, this is not supported and is not recommended. + * + * [Api set: Mailbox 1.1] + * + * @remarks + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadWriteItem + * + * Applicable Outlook mode: Message Compose + * + * Errors: + * + * NumberOfAttachmentsExceeded - The message or appointment has too many attachments. + * + * @param itemId The Exchange identifier of the item to attach. The maximum length is 100 characters. + * @param attachmentName The name of the attachment that is shown while the attachment is uploading. The maximum length is 255 characters. + * @param options An object literal that contains one or more of the following properties. + * asyncContext: Developers can provide any object they wish to access in the callback method. + */ + addItemAttachmentAsync(itemId: any, attachmentName: string, options: AsyncContextOptions): void; + /** + * Adds an Exchange item, such as a message, as an attachment to the message or appointment. + * + * The addItemAttachmentAsync method attaches the item with the specified Exchange identifier to the item in the compose form. If you specify a callback method, the method is called with one parameter, asyncResult, which contains either the attachment identifier or a code that indicates any error that occurred while attaching the item. You can use the options parameter to pass state information to the callback method, if needed. + * + * You can subsequently use the identifier with the removeAttachmentAsync method to remove the attachment in the same session. + * + * If your Office add-in is running in Outlook Web App, the addItemAttachmentAsync method can attach items to items other than the item that you are editing; however, this is not supported and is not recommended. + * + * [Api set: Mailbox 1.1] + * + * @remarks + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadWriteItem + * + * Applicable Outlook mode: Message Compose + * + * Errors: + * + * NumberOfAttachmentsExceeded - The message or appointment has too many attachments. + * + * @param itemId The Exchange identifier of the item to attach. The maximum length is 100 characters. + * @param attachmentName The name of the attachment that is shown while the attachment is uploading. The maximum length is 255 characters. + * @param callback When the method completes, the function passed in the callback parameter is called with a single parameter of type AsyncResult. On success, the attachment identifier will be provided in the asyncResult.value property. If adding the attachment fails, the asyncResult object will contain an Error object that provides a description of the error. + */ + addItemAttachmentAsync(itemId: any, attachmentName: string, callback: (result: AsyncResult) => void): void; + + /** + * Closes the current item that is being composed + * + * The behaviors of the close method depends on the current state of the item being composed. If the item has unsaved changes, the client prompts the user to save, discard, or close the action. + * + * In the Outlook desktop client, if the message is an inline reply, the close method has no effect. + * + * Note: In Outlook on the web, if the item is an appointment and it has previously been saved using saveAsync, the user is prompted to save, discard, or cancel even if no changes have occurred since the item was last saved. + * + * [Api set: Mailbox 1.3] + * + * @remarks + * + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: Restricted + * + * Applicable Outlook mode: Message Compose + */ + close(): void; + /** + * Gets initialization data passed when the add-in is activated by an actionable message. + * + * Note: This method is only supported by Outlook 2016 for Windows (Click-to-Run versions greater than 16.0.8413.1000) and Outlook on the web for Office 365. + * + * [Api set: Mailbox Preview] + * + * @remarks + * + * More information on {@link https://docs.microsoft.com/outlook/actionable-messages/invoke-add-in-from-actionable-message | actionable messages}. + * + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadItem + * + * Applicable Outlook mode: Message Compose + * + * @param options Optional. An object literal that contains one or more of the following properties. + * asyncContext: Developers can provide any object they wish to access in the callback method. + * @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of type AsyncResult. On success, the initialization data is provided in the asyncResult.value property as a string. If there is no initialization context, the asyncResult object will contain an Error object with its code property set to 9020 and its name property set to GenericResponseError. + */ + getInitializationContextAsync(options?: AsyncContextOptions, callback?: (result: AsyncResult) => void): void; + /** + * Asynchronously returns selected data from the subject or body of a message. + * + * If there is no selection but the cursor is in the body or subject, the method returns null for the selected data. If a field other than the body or subject is selected, the method returns the InvalidSelection error. + * + * To access the selected data from the callback method, call asyncResult.value.data. To access the source property that the selection comes from, call asyncResult.value.sourceProperty, which will be either body or subject. + * + * [Api set: Mailbox 1.0] + * + * @returns + * The selected data as a string with format determined by coercionType. + * + * @remarks + * + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadWriteItem + * + * Applicable Outlook mode: Message Compose + * + * @param coercionType Requests a format for the data. If Text, the method returns the plain text as a string , removing any HTML tags present. If HTML, the method returns the selected text, whether it is plaintext or HTML. + * @param callback When the method completes, the function passed in the callback parameter is called with a single parameter of type AsyncResult. + */ + getSelectedDataAsync(coercionType: CoercionType, callback: (result: AsyncResult) => void): void; + /** + * Asynchronously returns selected data from the subject or body of a message. + * + * If there is no selection but the cursor is in the body or subject, the method returns null for the selected data. If a field other than the body or subject is selected, the method returns the InvalidSelection error. + * + * To access the selected data from the callback method, call asyncResult.value.data. To access the source property that the selection comes from, call asyncResult.value.sourceProperty, which will be either body or subject. + * + * [Api set: Mailbox 1.0] + * + * @returns + * The selected data as a string with format determined by coercionType. + * + * @remarks + * + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadWriteItem + * + * Applicable Outlook mode: Message Compose + * + * @param coercionType Requests a format for the data. If Text, the method returns the plain text as a string , removing any HTML tags present. If HTML, the method returns the selected text, whether it is plaintext or HTML. + * @param options An object literal that contains one or more of the following properties. + * asyncContext: Developers can provide any object they wish to access in the callback method. + * @param callback When the method completes, the function passed in the callback parameter is called with a single parameter of type AsyncResult. + */ + getSelectedDataAsync(coercionType: CoercionType, options: AsyncContextOptions, callback: (result: AsyncResult) => void): void; + /** + * Removes an attachment from a message or appointment. + * + * The removeAttachmentAsync method removes the attachment with the specified identifier from the item. As a best practice, you should use the attachment identifier to remove an attachment only if the same mail app has added that attachment in the same session. In Outlook Web App and OWA for Devices, the attachment identifier is valid only within the same session. A session is over when the user closes the app, or if the user starts composing in an inline form and subsequently pops out the inline form to continue in a separate window. + * + * [Api set: Mailbox 1.1] + * + * @remarks + * + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadWriteItem + * + * Applicable Outlook mode: Message Compose + * + * Errors: InvalidAttachmentId - The attachment identifier does not exist. + * + * In addition to this signature, the method also has the following signatures: + * + * removeAttachmentAsync(attachmentIndex: string): void; + * + * removeAttachmentAsync(attachmentIndex: string, options: AsyncContextOptions): void; + * + * removeAttachmentAsync(attachmentIndex: string, callback: (result: AsyncResult) => void): void; + * + * @param attachmentIndex The identifier of the attachment to remove. The maximum length of the string is 100 characters. + * @param options Optional. An object literal that contains one or more of the following properties. + * asyncContext: Developers can provide any object they wish to access in the callback method. + * @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of type AsyncResult. If removing the attachment fails, the asyncResult.error property will contain an error code with the reason for the failure. + */ + removeAttachmentAsync(attachmentIndex: string, options?: AsyncContextOptions, callback?: (result: AsyncResult) => void): void; + /** + * Removes an attachment from a message or appointment. + * + * The removeAttachmentAsync method removes the attachment with the specified identifier from the item. As a best practice, you should use the attachment identifier to remove an attachment only if the same mail app has added that attachment in the same session. In Outlook Web App and OWA for Devices, the attachment identifier is valid only within the same session. A session is over when the user closes the app, or if the user starts composing in an inline form and subsequently pops out the inline form to continue in a separate window. + * + * [Api set: Mailbox 1.1] + * + * @remarks + * + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadWriteItem + * + * Applicable Outlook mode: Message Compose + * + * Errors: InvalidAttachmentId - The attachment identifier does not exist. + * + * @param attachmentIndex The identifier of the attachment to remove. The maximum length of the string is 100 characters. + */ + removeAttachmentAsync(attachmentIndex: string): void; + /** + * Removes an attachment from a message or appointment. + * + * The removeAttachmentAsync method removes the attachment with the specified identifier from the item. As a best practice, you should use the attachment identifier to remove an attachment only if the same mail app has added that attachment in the same session. In Outlook Web App and OWA for Devices, the attachment identifier is valid only within the same session. A session is over when the user closes the app, or if the user starts composing in an inline form and subsequently pops out the inline form to continue in a separate window. + * + * [Api set: Mailbox 1.1] + * + * @remarks + * + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadWriteItem + * + * Applicable Outlook mode: Message Compose + * + * Errors: InvalidAttachmentId - The attachment identifier does not exist. + * + * @param attachmentIndex The identifier of the attachment to remove. The maximum length of the string is 100 characters. + * @param options Optional. An object literal that contains one or more of the following properties. + * asyncContext: Developers can provide any object they wish to access in the callback method. + */ + removeAttachmentAsync(attachmentIndex: string, options: AsyncContextOptions): void; + /** + * Removes an attachment from a message or appointment. + * + * The removeAttachmentAsync method removes the attachment with the specified identifier from the item. As a best practice, you should use the attachment identifier to remove an attachment only if the same mail app has added that attachment in the same session. In Outlook Web App and OWA for Devices, the attachment identifier is valid only within the same session. A session is over when the user closes the app, or if the user starts composing in an inline form and subsequently pops out the inline form to continue in a separate window. + * + * [Api set: Mailbox 1.1] + * + * @remarks + * + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadWriteItem + * + * Applicable Outlook mode: Message Compose + * + * Errors: InvalidAttachmentId - The attachment identifier does not exist. + * + * @param attachmentIndex The identifier of the attachment to remove. The maximum length of the string is 100 characters. + * @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of type AsyncResult. If removing the attachment fails, the asyncResult.error property will contain an error code with the reason for the failure. + */ + removeAttachmentAsync(attachmentIndex: string, callback: (result: AsyncResult) => void): void; + + /** + * Asynchronously saves an item. + * + * When invoked, this method saves the current message as a draft and returns the item id via the callback method. In Outlook Web App or Outlook in online mode, the item is saved to the server. In Outlook in cached mode, the item is saved to the local cache. + * + * Since appointments have no draft state, if saveAsync is called on an appointment in compose mode, the item will be saved as a normal appointment on the user's calendar. For new appointments that have not been saved before, no invitation will be sent. Saving an existing appointment will send an update to added or removed attendees. + * + * Note: If your add-in calls saveAsync on an item in compose mode in order to get an itemId to use with EWS or the REST API, be aware that when Outlook is in cached mode, it may take some time before the item is actually synced to the server. Until the item is synced, using the itemId will return an error. + * + * Note: The following clients have different behavior for saveAsync on appointments in compose mode: + * + * - Mac Outlook does not support saveAsync on a meeting in compose mode. Calling saveAsync on a meeting in Mac Outlook will return an error. + * + * - Outlook on the web always sends an invitation or update when saveAsync is called on an appointment in compose mode. + * + * [Api set: Mailbox 1.3] + * + * @remarks + * + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadWriteItem + * + * Applicable Outlook mode: Message Compose + * + * Errors: InvalidAttachmentId - The attachment identifier does not exist. + * + * In addition to this signature, the method also has the following signatures: + * + * saveAsync(): void; + * + * saveAsync(options: AsyncContextOptions): void; + * + * saveAsync(callback: (result: AsyncResult) => void): void; + * + * @param options Optional. An object literal that contains one or more of the following properties. + * asyncContext: Developers can provide any object they wish to access in the callback method. + * @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of type AsyncResult. If removing the attachment fails, the asyncResult.error property will contain an error code with the reason for the failure. + */ + saveAsync(options?: AsyncContextOptions, callback?: (result: AsyncResult) => void): void; + /** + * Asynchronously saves an item. + * + * When invoked, this method saves the current message as a draft and returns the item id via the callback method. In Outlook Web App or Outlook in online mode, the item is saved to the server. In Outlook in cached mode, the item is saved to the local cache. + * + * Since appointments have no draft state, if saveAsync is called on an appointment in compose mode, the item will be saved as a normal appointment on the user's calendar. For new appointments that have not been saved before, no invitation will be sent. Saving an existing appointment will send an update to added or removed attendees. + * + * Note: If your add-in calls saveAsync on an item in compose mode in order to get an itemId to use with EWS or the REST API, be aware that when Outlook is in cached mode, it may take some time before the item is actually synced to the server. Until the item is synced, using the itemId will return an error. + * + * Note: The following clients have different behavior for saveAsync on appointments in compose mode: + * + * - Mac Outlook does not support saveAsync on a meeting in compose mode. Calling saveAsync on a meeting in Mac Outlook will return an error. + * + * - Outlook on the web always sends an invitation or update when saveAsync is called on an appointment in compose mode. + * + * [Api set: Mailbox 1.3] + * + * @remarks + * + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadWriteItem + * + * Applicable Outlook mode: Message Compose + * + * Errors: InvalidAttachmentId - The attachment identifier does not exist. + * + */ + saveAsync(): void; + /** + * Asynchronously saves an item. + * + * When invoked, this method saves the current message as a draft and returns the item id via the callback method. In Outlook Web App or Outlook in online mode, the item is saved to the server. In Outlook in cached mode, the item is saved to the local cache. + * + * Since appointments have no draft state, if saveAsync is called on an appointment in compose mode, the item will be saved as a normal appointment on the user's calendar. For new appointments that have not been saved before, no invitation will be sent. Saving an existing appointment will send an update to added or removed attendees. + * + * Note: If your add-in calls saveAsync on an item in compose mode in order to get an itemId to use with EWS or the REST API, be aware that when Outlook is in cached mode, it may take some time before the item is actually synced to the server. Until the item is synced, using the itemId will return an error. + * + * Note: The following clients have different behavior for saveAsync on appointments in compose mode: + * + * - Mac Outlook does not support saveAsync on a meeting in compose mode. Calling saveAsync on a meeting in Mac Outlook will return an error. + * + * - Outlook on the web always sends an invitation or update when saveAsync is called on an appointment in compose mode. + * + * [Api set: Mailbox 1.3] + * + * @remarks + * + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadWriteItem + * + * Applicable Outlook mode: Message Compose + * + * Errors: InvalidAttachmentId - The attachment identifier does not exist. + * + * @param options Optional. An object literal that contains one or more of the following properties. + * asyncContext: Developers can provide any object they wish to access in the callback method. + */ + saveAsync(options: AsyncContextOptions): void; + /** + * Asynchronously saves an item. + * + * When invoked, this method saves the current message as a draft and returns the item id via the callback method. In Outlook Web App or Outlook in online mode, the item is saved to the server. In Outlook in cached mode, the item is saved to the local cache. + * + * Since appointments have no draft state, if saveAsync is called on an appointment in compose mode, the item will be saved as a normal appointment on the user's calendar. For new appointments that have not been saved before, no invitation will be sent. Saving an existing appointment will send an update to added or removed attendees. + * + * Note: If your add-in calls saveAsync on an item in compose mode in order to get an itemId to use with EWS or the REST API, be aware that when Outlook is in cached mode, it may take some time before the item is actually synced to the server. Until the item is synced, using the itemId will return an error. + * + * Note: The following clients have different behavior for saveAsync on appointments in compose mode: + * + * - Mac Outlook does not support saveAsync on a meeting in compose mode. Calling saveAsync on a meeting in Mac Outlook will return an error. + * + * - Outlook on the web always sends an invitation or update when saveAsync is called on an appointment in compose mode. + * + * [Api set: Mailbox 1.3] + * + * @remarks + * + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadWriteItem + * + * Applicable Outlook mode: Message Compose + * + * Errors: InvalidAttachmentId - The attachment identifier does not exist. + * + * @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of type AsyncResult. If removing the attachment fails, the asyncResult.error property will contain an error code with the reason for the failure. + */ + saveAsync(callback: (result: AsyncResult) => void): void; + /** + * Asynchronously inserts data into the body or subject of a message. + * + * The setSelectedDataAsync method inserts the specified string at the cursor location in the subject or body of the item, or, if text is selected in the editor, it replaces the selected text. If the cursor is not in the body or subject field, an error is returned. After insertion, the cursor is placed at the end of the inserted content. + * + * [Api set: Mailbox 1.2] + * + * @remarks + * + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadWriteItem + * + * Applicable Outlook mode: Message Compose + * + * Errors: InvalidAttachmentId - The attachment identifier does not exist. + * + * In addition to this signature, the method also has the following signatures: + * + * setSelectedDataAsync(data: string): void; + * + * setSelectedDataAsync(data: string, options: AsyncContextOptions & CoercionTypeOptions): void; + * + * setSelectedDataAsync(data: string, callback: (result: AsyncResult) => void): void; + * + * @param data The data to be inserted. Data is not to exceed 1,000,000 characters. If more than 1,000,000 characters are passed in, an ArgumentOutOfRange exception is thrown. + * @param options Optional. An object literal that contains one or more of the following properties. + * asyncContext: Developers can provide any object they wish to access in the callback method. + * coercionType: If text, the current style is applied in Outlook Web App and Outlook. If the field is an HTML editor, only the text data is inserted, even if the data is HTML. If html and the field supports HTML (the subject doesn't), the current style is applied in Outlook Web App and the default style is applied in Outlook. If the field is a text field, an InvalidDataFormat error is returned. If coercionType is not set, the result depends on the field: if the field is HTML then HTML is used; if the field is text, then plain text is used. + * @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of type AsyncResult. If removing the attachment fails, the asyncResult.error property will contain an error code with the reason for the failure. + */ + setSelectedDataAsync(data: string, options?: AsyncContextOptions & CoercionTypeOptions, callback?: (result: AsyncResult) => void): void; + /** + * Asynchronously inserts data into the body or subject of a message. + * + * The setSelectedDataAsync method inserts the specified string at the cursor location in the subject or body of the item, or, if text is selected in the editor, it replaces the selected text. If the cursor is not in the body or subject field, an error is returned. After insertion, the cursor is placed at the end of the inserted content. + * + * [Api set: Mailbox 1.2] + * + * @remarks + * + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadWriteItem + * + * Applicable Outlook mode: Message Compose + * + * Errors: InvalidAttachmentId - The attachment identifier does not exist. + * + * @param data The data to be inserted. Data is not to exceed 1,000,000 characters. If more than 1,000,000 characters are passed in, an ArgumentOutOfRange exception is thrown. + */ + setSelectedDataAsync(data: string): void; + /** + * Asynchronously inserts data into the body or subject of a message. + * + * The setSelectedDataAsync method inserts the specified string at the cursor location in the subject or body of the item, or, if text is selected in the editor, it replaces the selected text. If the cursor is not in the body or subject field, an error is returned. After insertion, the cursor is placed at the end of the inserted content. + * + * [Api set: Mailbox 1.2] + * + * @remarks + * + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadWriteItem + * + * Applicable Outlook mode: Message Compose + * + * Errors: InvalidAttachmentId - The attachment identifier does not exist. + * + * @param data The data to be inserted. Data is not to exceed 1,000,000 characters. If more than 1,000,000 characters are passed in, an ArgumentOutOfRange exception is thrown. + * @param options Optional. An object literal that contains one or more of the following properties. + * asyncContext: Developers can provide any object they wish to access in the callback method. + * coercionType: If text, the current style is applied in Outlook Web App and Outlook. If the field is an HTML editor, only the text data is inserted, even if the data is HTML. If html and the field supports HTML (the subject doesn't), the current style is applied in Outlook Web App and the default style is applied in Outlook. If the field is a text field, an InvalidDataFormat error is returned. If coercionType is not set, the result depends on the field: if the field is HTML then HTML is used; if the field is text, then plain text is used. + */ + setSelectedDataAsync(data: string, options: AsyncContextOptions & CoercionTypeOptions): void; + /** + * Asynchronously inserts data into the body or subject of a message. + * + * The setSelectedDataAsync method inserts the specified string at the cursor location in the subject or body of the item, or, if text is selected in the editor, it replaces the selected text. If the cursor is not in the body or subject field, an error is returned. After insertion, the cursor is placed at the end of the inserted content. + * + * [Api set: Mailbox 1.2] + * + * @remarks + * + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadWriteItem + * + * Applicable Outlook mode: Message Compose + * + * Errors: InvalidAttachmentId - The attachment identifier does not exist. + * + * @param data The data to be inserted. Data is not to exceed 1,000,000 characters. If more than 1,000,000 characters are passed in, an ArgumentOutOfRange exception is thrown. + * @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of type AsyncResult. If removing the attachment fails, the asyncResult.error property will contain an error code with the reason for the failure. + */ + setSelectedDataAsync(data: string, callback: (result: AsyncResult) => void): void; } /** + * The message read mode of {@link Office.Item | Office.context.mailbox.item}. + * * Important: This is an internal Outlook object, not directly exposed through existing interfaces. You should treat this as a mode of Office.context.mailbox.item. Refer to the Object Model pages for more information. */ interface MessageRead extends Message, ItemRead { @@ -8086,7 +10315,7 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadItem * - * Applicable Outlook mode: Compose or read + * Applicable Outlook mode: Message Read */ cc: EmailAddressDetails[]; /** @@ -8104,11 +10333,11 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadItem * - * Applicable Outlook mode: Read + * Applicable Outlook mode: Message Read */ from: EmailAddressDetails; /** - * Gets the Internet message identifier for an email message. Read mode only. + * Gets the Internet message identifier for an email message. * * [Api set: Mailbox 1.0] * @@ -8116,11 +10345,11 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadItem * - * Applicable Outlook mode: Read + * Applicable Outlook mode: Message Read */ internetMessageId: string; /** - * Gets the email address of the sender of an email message. Read mode only. + * Gets the email address of the sender of an email message. * * The from and sender properties represent the same person unless the message is sent by a delegate. In that case, the from property represents the delegator, and the sender property represents the delegate. * @@ -8132,7 +10361,7 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadItem * - * Applicable Outlook mode: Read + * Applicable Outlook mode: Message Read */ sender: EmailAddressDetails; /** @@ -8146,9 +10375,536 @@ declare namespace Office { * * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadItem * - * Applicable Outlook mode: Compose or read + * Applicable Outlook mode: Message Read */ to: EmailAddressDetails[]; + + // Repeated Item Fields // + + /** + * Gets an object that provides methods for manipulating the body of an item. + * + * [Api set: Mailbox 1.1] + * + * @remarks + * + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadItem + * + * Applicable Outlook mode: Message Read + */ + body: Body; + /** + * Gets the date and time that an item was created. Read mode only. + * + * [Api set: Mailbox 1.0] + * + * @remarks + * + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadItem + * + * Applicable Outlook mode: Message Read + */ + dateTimeCreated: Date; + /** + * Gets the date and time that an item was last modified. Read mode only. + * + * [Api set: Mailbox 1.0] + * + * @remarks + * + * Note: This member is not supported in Outlook for iOS or Outlook for Android. + * + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadItem + * + * Applicable Outlook mode: Message Read + */ + dateTimeModifed: Date; + /** + * Gets the type of item that an instance represents. + * + * The itemType property returns one of the ItemType enumeration values, indicating whether the item object instance is a message or an appointment. + * + * [Api set: Mailbox 1.0] + * + * @remarks + * + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadItem + * + * Applicable Outlook mode: Message Read + */ + itemType: Office.MailboxEnums.ItemType; + /** + * Gets the notification messages for an item. + * + * [Api set: Mailbox 1.3] + * + * @remarks + * + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadItem + * + * Applicable Outlook mode: Compose or read + */ + notificationMessages: NotificationMessages; + + /** + * Gets the recurrence pattern of an appointment. Gets the recurrence pattern of a meeting request. Read and compose modes for appointment items. Read mode for meeting request items. + * + * The recurrence property returns a recurrence object for recurring appointments or meetings requests if an item is a series or an instance in a series. null is returned for single appointments and meeting requests of single appointments. undefined is returned for messages that are not meeting requests. + * + * Note: Meeting requests have an itemClass value of IPM.Schedule.Meeting.Request. + * + * Note: If the recurrence object is null, this indicates that the object is a single appointment or a meeting request of a single appointment and NOT a part of a series. + * + * [Api set: Mailbox Preview] + * + * @remarks + * + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadItem + * + * Applicable Outlook mode: Message Read + */ + recurrence: Recurrence; + + /** + * Gets the id of the series that an instance belongs to. + * + * In OWA and Outlook, the seriesId returns the Exchange Web Services (EWS) ID of the parent (series) item that this item belongs to. However, in iOS and Android, the seriesId returns the REST ID of the parent item. + * + * Note: The identifier returned by the seriesId property is the same as the Exchange Web Services item identifier. The seriesId property is not identical to the Outlook IDs used by the Outlook REST API. Before making REST API calls using this value, it should be converted using Office.context.mailbox.convertToRestId. For more details, see {@link https://docs.microsoft.com/outlook/add-ins/use-rest-api | Use the Outlook REST APIs from an Outlook add-in}. + * + * The seriesId property returns null for items that do not have parent items such as single appointments, series items, or meeting requests and returns undefined for any other items that are not meeting requests. + * + * [Api set: Mailbox Preview] + * + * @remarks + * + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadItem + * + * Applicable Outlook mode: Message Read + */ + seriesId: string; + + /** + * Adds an event handler for a supported event. + * + * Currently the only supported event type is Office.EventType.RecurrencePatternChanged, which is invoked when the user changes the recurrence pattern of a series. + * + * [Api set: Mailbox Preview] + * + * @remarks + * + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadItem + * + * Applicable Outlook mode: Message Read + * + * In addition to this signature, the method also has the following signatures: + * + * addHandlerAsync(eventType:EventType, handler: any, callback?: (result: AsyncResult) => void): void; + * + * @param eventType The event that should invoke the handler. + * @param handler The function to handle the event. The function must accept a single parameter, which is an object literal. The type property on the parameter will match the eventType parameter passed to addHandlerAsync. + * @param options Optional. An object literal that contains one or more of the following properties. + * asyncContext: Developers can provide any object they wish to access in the callback method. + * @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter, asyncResult, which is an AsyncResult object. + */ + addHandlerAsync(eventType:EventType, handler: any, options?: any, callback?: (result: AsyncResult) => void): void; + + /** + * Adds an event handler for a supported event. + * + * Currently the only supported event type is Office.EventType.RecurrencePatternChanged, which is invoked when the user changes the recurrence pattern of a series. + * + * [Api set: Mailbox Preview] + * + * @remarks + * + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadItem + * + * Applicable Outlook mode: Message Read + * + * @param eventType The event that should invoke the handler. + * @param handler The function to handle the event. The function must accept a single parameter, which is an object literal. The type property on the parameter will match the eventType parameter passed to addHandlerAsync. + * @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter, asyncResult, which is an AsyncResult object. + */ + addHandlerAsync(eventType:EventType, handler: any, callback?: (result: AsyncResult) => void): void; + + /** + * Asynchronously loads custom properties for this add-in on the selected item. + * + * Custom properties are stored as key/value pairs on a per-app, per-item basis. This method returns a CustomProperties object in the callback, which provides methods to access the custom properties specific to the current item and the current add-in. Custom properties are not encrypted on the item, so this should not be used as secure storage. + * + * The custom properties are provided as a CustomProperties object in the asyncResult.value property. This object can be used to get, set, and remove custom properties from the item and save changes to the custom property set back to the server. + * + * [Api set: Mailbox 1.0] + * + * @remarks + * + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadItem + * + * Applicable Outlook mode: Message Read + * + * @param callback When the method completes, the function passed in the callback parameter is called with a single parameter of type AsyncResult. + * @param userContext Optional. Developers can provide any object they wish to access in the callback function. This object can be accessed by the asyncResult.asyncContext property in the callback function. + */ + loadCustomPropertiesAsync(callback: (result: AsyncResult) => void, userContext?: any): void; + + /** + * Removes an event handler for a supported event. + * + * Currently the only supported event type is Office.EventType.RecurrencePatternChanged, which is invoked when the user changes the recurrence pattern of a series. + * + * [Api set: Mailbox Preview] + * + * @remarks + * + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadItem + * + * Applicable Outlook mode: Message Read + * + * In addition to this signature, the method also has the following signatures: + * + * removeHandlerAsync(eventType:EventType, handler: any, callback?: (result: AsyncResult) => void): void; + * + * @param eventType The event that should invoke the handler. + * @param handler The function to handle the event. The function must accept a single parameter, which is an object literal. The type property on the parameter will match the eventType parameter passed to removeHandlerAsync. + * @param options Optional. An object literal that contains one or more of the following properties. + * asyncContext: Developers can provide any object they wish to access in the callback method. + * @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter, asyncResult, which is an AsyncResult object. + */ + removeHandlerAsync(eventType:EventType, handler: any, options?: any, callback?: (result: AsyncResult) => void): void; + + /** + * Removes an event handler for a supported event. + * + * Currently the only supported event type is Office.EventType.RecurrencePatternChanged, which is invoked when the user changes the recurrence pattern of a series. + * + * [Api set: Mailbox Preview] + * + * @remarks + * + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadItem + * + * Applicable Outlook mode: Message Read + * + * @param eventType The event that should invoke the handler. + * @param handler The function to handle the event. The function must accept a single parameter, which is an object literal. The type property on the parameter will match the eventType parameter passed to removeHandlerAsync. + * @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter, asyncResult, which is an AsyncResult object. + */ + removeHandlerAsync(eventType:EventType, handler: any, callback?: (result: AsyncResult) => void): void; + + /** + * Gets an array of attachments for the item. + * + * [Api set: Mailbox 1.0] + * + * @remarks + * + * Note: Certain types of files are blocked by Outlook due to potential security issues and are therefore not returned. For more information, see {@link https://support.office.com/article/Blocked-attachments-in-Outlook-434752E1-02D3-4E90-9124-8B81E49A8519 | Blocked attachments in Outlook}. + * + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadItem + * + * Applicable Outlook mode: Message Read + * + */ + attachments: AttachmentDetails[]; + /** + * Gets the Exchange Web Services item class of the selected item. + * + * You can create custom message classes that extends a default message class, for example, a custom appointment message class IPM.Appointment.Contoso. + * + * [Api set: Mailbox 1.0] + * + * @remarks + * + + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadItem + * + * Applicable Outlook mode: Message Read + * + * The itemClass property specifies the message class of the selected item. The following are the default message classes for the message or appointment item. + * + * |Type|Description|Item Class| + * |-----------|------------|------------| + * |Appointment items|These are calendar items of the item class IPM.Appointment or IPM.Appointment.Occurence.|IPM.Appointment,IPM.Appointment.Occurence| + * |Message items|These include email messages that have the default message class IPM.Note, and meeting requests, responses, and cancellations, that use IPM.Schedule.Meeting as the base message class.|IPM.Note,IPM.Schedule.Meeting.Request,IPM.Schedule.Meeting.Neg,IPM.Schedule.Meeting.Pos,IPM.Schedule.Meeting.Tent,IPM.Schedule.Meeting.Canceled| + */ + itemClass: string; + /** + * Gets the Exchange Web Services item identifier for the current item. + * + * The itemId property is not available in compose mode. If an item identifier is required, the saveAsync method can be used to save the item to the store, which will return the item identifier in the AsyncResult.value parameter in the callback function. + * + * Note: The identifier returned by the itemId property is the same as the Exchange Web Services item identifier. The itemId property is not identical to the Outlook Entry ID or the ID used by the Outlook REST API. Before making REST API calls using this value, it should be converted using Office.context.mailbox.convertToRestId. For more details, see Use the Outlook REST APIs from an Outlook add-in. + * + * [Api set: Mailbox 1.0] + * + * @remarks + * + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadItem + * + * Applicable Outlook mode: Message Read + */ + itemId: string; + /** + * Gets the subject of an item, with all prefixes removed (including RE: and FWD:). + * + * The normalizedSubject property gets the subject of the item, with any standard prefixes (such as RE: and FW:) that are added by email programs. To get the subject of the item with the prefixes intact, use the subject property. + * + * [Api set: Mailbox 1.0] + * + * @remarks + * + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadItem + * + * Applicable Outlook mode: Message Read + */ + normalizedSubject: string; + /** + * Gets the description that appears in the subject field of an item. + * + * The subject property gets or sets the entire subject of the item, as sent by the email server. + * + * The subject property returns a string. Use the normalizedSubject property to get the subject minus any leading prefixes such as RE: and FW:. + * + * [Api set: Mailbox 1.0] + * + * @remarks + * + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadItem + * + * Applicable Outlook mode: Message Read + */ + subject: string; + /** + * Displays a reply form that includes the sender and all recipients of the selected message or the organizer and all attendees of the selected appointment. + * + * In Outlook Web App, the reply form is displayed as a pop-out form in the 3-column view and a pop-up form in the 2- or 1-column view. + * + * If any of the string parameters exceed their limits, displayReplyAllForm throws an exception. + * + * When attachments are specified in the formData.attachments parameter, Outlook and Outlook Web App attempt to download all attachments and attach them to the reply form. If any attachments fail to be added, an error is shown in the form UI. If this isn't possible, then no error message is thrown. + * + * Note: This method is not supported in Outlook for iOS or Outlook for Android. + * + * [Api set: Mailbox 1.0] + * + * @remarks + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadItem + * + * Applicable Outlook mode: Message Read + * + * @param formData A string that contains text and HTML and that represents the body of the reply form. The string is limited to 32 KB + * OR + * An {@link Office.ReplyFormData} object that contains body or attachment data and a callback function + */ + displayReplyAllForm(formData: string | ReplyFormData): void; + /** + * Displays a reply form that includes only the sender of the selected message or the organizer of the selected appointment. + * + * In Outlook Web App, the reply form is displayed as a pop-out form in the 3-column view and a pop-up form in the 2- or 1-column view. + * + * If any of the string parameters exceed their limits, displayReplyForm throws an exception. + * + * When attachments are specified in the formData.attachments parameter, Outlook and Outlook Web App attempt to download all attachments and attach them to the reply form. If any attachments fail to be added, an error is shown in the form UI. If this isn't possible, then no error message is thrown. + * + * Note: This method is not supported in Outlook for iOS or Outlook for Android. + * + * [Api set: Mailbox 1.0] + * + * @remarks + * + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadItem + * + * Applicable Outlook mode: Message Read + * + * @param formData A string that contains text and HTML and that represents the body of the reply form. The string is limited to 32 KB. + * OR + * An {@link Office.ReplyFormData} object that contains body or attachment data and a callback function. + */ + displayReplyForm(formData: string | ReplyFormData): void; + /** + * Gets initialization data passed when the add-in is {@link https://docs.microsoft.com/outlook/actionable-messages/invoke-add-in-from-actionable-message | activated by an actionable message}. + * + * Note: This method is only supported by Outlook 2016 for Windows (Click-to-Run versions greater than 16.0.8413.1000) and Outlook on the web for Office 365. + * + * [Api set: Mailbox Preview] + * + * @remarks + * + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadItem + * + * Applicable Outlook mode: Message Read + * + * In addition to this signature, the method also has the following signatures: + * + * getInitializationContextAsync(callback?: (result: AsyncResult) => void): void; + * + * @param options Optional. An object literal that contains one or more of the following properties. + * asyncContext: Developers can provide any object they wish to access in the callback method. + * @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter, asyncResult, which is an AsyncResult object. On success, the initialization data is provided in the asyncResult.value property as a string. If there is no initialization context, the asyncResult object will contain an Error object with its code property set to 9020 and its name property set to GenericResponseError. + */ + getInitializationContextAsync(options?: AsyncContextOptions, callback?: (result: AsyncResult) => void): void; + /** + * Gets initialization data passed when the add-in is {@link https://docs.microsoft.com/outlook/actionable-messages/invoke-add-in-from-actionable-message | activated by an actionable message}. + * + * Note: This method is only supported by Outlook 2016 for Windows (Click-to-Run versions greater than 16.0.8413.1000) and Outlook on the web for Office 365. + * + * [Api set: Mailbox Preview] + * + * @remarks + * + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadItem + * + * Applicable Outlook mode: Message Read + * + * @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter, asyncResult, which is an AsyncResult object. On success, the initialization data is provided in the asyncResult.value property as a string. If there is no initialization context, the asyncResult object will contain an Error object with its code property set to 9020 and its name property set to GenericResponseError. + */ + getInitializationContextAsync(callback?: (result: AsyncResult) => void): void; + /** + * Gets the entities found in the selected item. + * + * Note: This method is not supported in Outlook for iOS or Outlook for Android. + * + * [Api set: Mailbox 1.0] + * + * @remarks + * + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadItem + * + * Applicable Outlook mode: Message Read + */ + getEntities(): Entities; + /** + * Gets an array of all the entities of the specified entity type found in the selected item. + * + * Note: This method is not supported in Outlook for iOS or Outlook for Android. + * + * [Api set: Mailbox 1.0] + * + * @param entityType One of the EntityType enumeration values. + * + * @returns + * If the value passed in entityType is not a valid member of the EntityType enumeration, the method returns null. If no entities of the specified type are present on the item, the method returns an empty array. Otherwise, the type of the objects in the returned array depends on the type of entity requested in the entityType parameter. + * + * @remarks + * + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: Restricted + * + * Applicable Outlook mode: Message Read + * + * While the minimum permission level to use this method is Restricted, some entity types require ReadItem to access, as specified in the following table. + * + * |Value of entityType|Type of objects in returned array|Required Permission Level| + * |-------|-----------|----------| + * |Address|String|Restricted| + * |Contact|Contact|ReadItem| + * |EmailAddress|String|ReadItem| + * |MeetingSuggestion|MeetingSuggestion|ReadItem| + * |PhoneNumber|PhoneNumber|Restricted| + * |TaskSuggestion|TaskSuggestion|ReadItem| + * |URL|String|Restricted| + */ + getEntitiesByType(entityType: Office.MailboxEnums.EntityType): (string | Contact | MeetingSuggestion | PhoneNumber | TaskSuggestion)[]; + /** + * Returns well-known entities in the selected item that pass the named filter defined in the manifest XML file. + * + * The getFilteredEntitiesByName method returns the entities that match the regular expression defined in the ItemHasKnownEntity rule element in the manifest XML file with the specified FilterName element value. + * + * Note: This method is not supported in Outlook for iOS or Outlook for Android. + * + * [Api set: Mailbox 1.0] + * + * @remarks + * + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadItem + * + * Applicable Outlook mode: Message Read + * + * @param name The name of the ItemHasKnownEntity rule element that defines the filter to match. + * @returns If there is no ItemHasKnownEntity element in the manifest with a FilterName element value that matches the name parameter, the method returns null. If the name parameter does match an ItemHasKnownEntity element in the manifest, but there are no entities in the current item that match, the method return an empty array. + */ + getFilteredEntitiesByName(name: string): (string | Contact | MeetingSuggestion | PhoneNumber | TaskSuggestion)[]; + /** + * Returns string values in the selected item that match the regular expressions defined in the manifest XML file. + * + * The getRegExMatches method returns the strings that match the regular expression defined in each ItemHasRegularExpressionMatch or ItemHasKnownEntity rule element in the manifest XML file. For an ItemHasRegularExpressionMatch rule, a matching string has to occur in the property of the item that is specified by that rule. The PropertyName simple type defines the supported properties. + * + * If you specify an ItemHasRegularExpressionMatch rule on the body property of an item, the regular expression should further filter the body and should not attempt to return the entire body of the item. Using a regular expression such as .* to obtain the entire body of an item does not always return the expected results. Instead, use the Body.getAsync method to retrieve the entire body. + * + * Note: This method is not supported in Outlook for iOS or Outlook for Android. + * + * [Api set: Mailbox 1.0] + * + * @returns + * An object that contains arrays of strings that match the regular expressions defined in the manifest XML file. The name of each array is equal to the corresponding value of the RegExName attribute of the matching ItemHasRegularExpressionMatch rule or the FilterName attribute of the matching ItemHasKnownEntity rule. + * + * @remarks + * + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadItem + * + * Applicable Outlook mode: Message Read + */ + getRegExMatches(): any; + /** + * Returns string values in the selected item that match the named regular expression defined in the manifest XML file. + * + * The getRegExMatchesByName method returns the strings that match the regular expression defined in the ItemHasRegularExpressionMatch rule element in the manifest XML file with the specified RegExName element value. + * + * If you specify an ItemHasRegularExpressionMatch rule on the body property of an item, the regular expression should further filter the body and should not attempt to return the entire body of the item. Using a regular expression such as .* to obtain the entire body of an item does not always return the expected results. + * + * Note: This method is not supported in Outlook for iOS or Outlook for Android. + * + * [Api set: Mailbox 1.0] + * + * @returns + * An array that contains the strings that match the regular expression defined in the manifest XML file. + * + * @remarks + * + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadItem + * + * Applicable Outlook mode: Message Read + * + * @param name The name of the ItemHasRegularExpressionMatch rule element that defines the filter to match. + */ + getRegExMatchesByName(name: string): string[]; + /** + * Gets the entities found in a highlighted match a user has selected. Highlighted matches apply to contextual add-ins. + * + * Note: This method is not supported in Outlook for iOS or Outlook for Android. + * + * [Api set: Mailbox 1.6] + * + * @remarks + * + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadItem + * + * Applicable Outlook mode: Message Read + * + * @param name The name of the ItemHasRegularExpressionMatch rule element that defines the filter to match. + */ + getSelectedEntities(): Entities; + /** + * Returns string values in a highlighted match that match the regular expressions defined in the manifest XML file. Highlighted matches apply to contextual add-ins. + * + * The getSelectedRegExMatches method returns the strings that match the regular expression defined in each ItemHasRegularExpressionMatch or ItemHasKnownEntity rule element in the manifest XML file. For an ItemHasRegularExpressionMatch rule, a matching string has to occur in the property of the item that is specified by that rule. The PropertyName simple type defines the supported properties. + * + * If you specify an ItemHasRegularExpressionMatch rule on the body property of an item, the regular expression should further filter the body and should not attempt to return the entire body of the item. Using a regular expression such as .* to obtain the entire body of an item does not always return the expected results. Instead, use the Body.getAsync method to retrieve the entire body. + * + * Note: This method is not supported in Outlook for iOS or Outlook for Android. + * + * [Api set: Mailbox 1.6] + * + * @returns + * An object that contains arrays of strings that match the regular expressions defined in the manifest XML file. The name of each array is equal to the corresponding value of the RegExName attribute of the matching ItemHasRegularExpressionMatch rule or the FilterName attribute of the matching ItemHasKnownEntity rule. + * + * @remarks + * + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadItem + * + * Applicable Outlook mode: Message Read + */ + getSelectedRegExMatches(): any; } /** @@ -8224,6 +10980,7 @@ declare namespace Office { * Applicable Outlook mode: Compose * * In addition to this signature, the method also has the following signatures: + * * getAsync(callback: (result: AsyncResult) => void): void; * */ @@ -8263,8 +11020,11 @@ declare namespace Office { * Errors: DataExceedsMaximumSize - The location parameter is longer than 255 characters. * * In addition to this signature, the method also has the following signatures: + * * setAsync(location: string): void; + * * setAsync(location: string, options: AsyncContextOptions): void; + * * setAsync(location: string, callback: (result: AsyncResult) => void): void; */ setAsync(location: string, options?: AsyncContextOptions, callback?: (result: AsyncResult) => void): void; @@ -8342,6 +11102,27 @@ declare namespace Office { * Applicable Outlook mode: Compose or read */ interface Mailbox { + /** + * Provides diagnostic information to an Outlook add-in. + * + * Contains the following members: + * + * - hostName (string): A string that represents the name of the host application. It be one of the following values: Outlook, Mac Outlook, OutlookIOS, or OutlookWebApp. + * + * - hostVersion (string): A string that represents the version of either the host application or the Exchange Server. If the mail add-in is running on the Outlook desktop client or Outlook for iOS, the hostVersion property returns the version of the host application, Outlook. In Outlook Web App, the property returns the version of the Exchange Server. An example is the string 15.0.468.0. + * + * - OWAView (string): A string that represents the current view of Outlook Web App. If the host application is not Outlook Web App, then accessing this property results in undefined. Outlook Web App has three views (OneColumn - displayed when the screen is narrow, TwoColumns - displayed when the screen is wider, and ThreeColumns - displayed when the screen is wide.) that correspond to the width of the screen and the window, and the number of columns that can be displayed. + * + * More information is under {@link Office.Diagnostics}. + * + * [Api set: Mailbox 1.0] + * + * @remarks + * {@link https://docs.microsoft.com/outlook/add-ins/understanding-outlook-add-in-permissions | Minimum permission level}: ReadItem + * + * Applicable Outlook mode: Compose or read + */ + diagnostics: Diagnostics; /** * Gets the URL of the Exchange Web Services (EWS) endpoint for this email account. Read mode only. * @@ -8386,6 +11167,12 @@ declare namespace Office { * Applicable Outlook mode: Compose or read */ restUrl: string; + /** + * Information about the user associated with the mailbox. This includes their account type, display name, email adddress, and time zone. + * + * More information is under {@link Office.UserProfile} + */ + userProfile: UserProfile; /** * Adds an event handler for a supported event. * @@ -8404,7 +11191,7 @@ declare namespace Office { * @param options Optional. Provides an option for preserving context data of any type, unchanged, for use in a callback. * @param callback Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of type AsyncResult. */ - addHandlerAsync(eventType: Office.EventType, handler: (type: Office.EventType) => void, options?: AsyncContextOptions, callback?: (result: AsyncResult) => void): void; + addHandlerAsync(eventType: EventType, handler: (type: EventType) => void, options?: AsyncContextOptions, callback?: (result: AsyncResult) => void): void; /** * Converts an item ID formatted for REST into EWS format. * @@ -8607,7 +11394,9 @@ declare namespace Office { * Applicable Outlook mode: Compose and read * * In addition to this signature, the method has the following signature: + * * getCallbackTokenAsync(callback: (result: AsyncResult) => void): void; + * * getCallbackTokenAsync(callback: (result: AsyncResult) => void, userContext?: any): void; * * @param options An object literal that contains one or more of the following properties. @@ -8778,7 +11567,7 @@ declare namespace Office { */ key?: string; /** - * Specifies the {@link Office.MailboxEnums.ItemNotificationMessageType} of message. If type is ProgressIndicator or ErrorMessage, an icon is automatically supplied and the message is not persistent. Therefore the icon and persistent properties are not valid for these types of messages. Including them will result in an ArgumentException. If type is ProgressIndicator, the developer should remove or replace the progress indicator when the action is complete. + * Specifies the ItemNotificationMessageType of message. If type is ProgressIndicator or ErrorMessage, an icon is automatically supplied and the message is not persistent. Therefore the icon and persistent properties are not valid for these types of messages. Including them will result in an ArgumentException. If type is ProgressIndicator, the developer should remove or replace the progress indicator when the action is complete. */ type: Office.MailboxEnums.ItemNotificationMessageType; /** @@ -8895,6 +11684,7 @@ declare namespace Office { * Applicable Outlook mode: Compose or read * * In addition to the main signature, this method also has these signatures: + * * getAllAsync(callback: (result: AsyncResult) => void): void; * * @param options Optional. An object literal that contains one or more of the following properties. @@ -8926,8 +11716,11 @@ declare namespace Office { * Applicable Outlook mode: Compose or read * * In addition to the main signature, this method also has these signatures: + * * removeAsync(key: string): void; + * * removeAsync(key: string, options: AsyncContextOptions): void; + * * removeAsync(key: string, callback: (result: AsyncResult) => void): void; * * @param key The key for the notification message to remove. @@ -8991,8 +11784,11 @@ declare namespace Office { * Applicable Outlook mode: Compose or read * * In addition to the main signature, this method also has these signatures: + * * replaceAsync(key: string, JSONmessage: NotificationMessageDetails): void; + * * replaceAsync(key: string, JSONmessage: NotificationMessageDetails, options: AsyncContextOptions): void; + * * replaceAsync(key: string, JSONmessage: NotificationMessageDetails, callback: (result: AsyncResult) => void): void; * * @param key The key for the notification message to replace. It can't be longer than 32 characters. @@ -9110,8 +11906,11 @@ declare namespace Office { * Errors: NumberOfRecipientsExceeded - The number of recipients exceeded 100 entries. * * In addition to the main signature, this method also has these signatures: + * * addAsync(recipients: (string | EmailUser | EmailAddressDetails)[]): void; + * * addAsync(recipients: (string | EmailUser | EmailAddressDetails)[], options: AsyncContextOptions): void; + * * addAsync(recipients: (string | EmailUser | EmailAddressDetails)[], callback: (result: AsyncResult) => void): void; * * @param recipients The recipients to add to the recipients list. @@ -9195,7 +11994,7 @@ declare namespace Office { /** * Gets a recipient list for an appointment or message. * - * When the call completes, the asyncResult.value property will contain an array of{@link Office. EmailAddressDetails} objects. + * When the call completes, the asyncResult.value property will contain an array of{@link Office.EmailAddressDetails} objects. * * [Api set: Mailbox 1.1] * @@ -9205,6 +12004,7 @@ declare namespace Office { * Applicable Outlook mode: Compose * * In addition to the main signature, this method also has these signatures: + * * getAsync(callback: (result: AsyncResult) => void): void; * * @param options An object literal that contains one or more of the following properties. @@ -9250,8 +12050,11 @@ declare namespace Office { * Errors: NumberOfRecipientsExceeded - The number of recipients exceeded 100 entries. * * In addition to the main signature, this method also has these signatures: + * * setAsync(recipients: (string | EmailUser | EmailAddressDetails)[]): void; + * * setAsync(recipients: (string | EmailUser | EmailAddressDetails)[], options: AsyncContextOptions): void; + * * setAsync(recipients: (string | EmailUser | EmailAddressDetails)[], callback: (result: AsyncResult) => void): void; * * @param recipients The recipients to add to the recipients list. @@ -9402,7 +12205,7 @@ declare namespace Office { recurrenceType: MailboxEnums.RecurrenceType; /** - * This object enables you to manage the start and end dates of the recurring appointment series and the usual start and end times of instances. **This object is not in UTC time.** Instead, it is set in the time zone specified by the recurrenceTimeZone value or defaulted to the item's time zone. + * The {@link Office.SeriesTime} object enables you to manage the start and end dates of the recurring appointment series and the usual start and end times of instances. **This object is not in UTC time.** Instead, it is set in the time zone specified by the recurrenceTimeZone value or defaulted to the item's time zone. * * [Api set: Mailbox Preview] * @@ -9428,6 +12231,7 @@ declare namespace Office { * Applicable Outlook mode: Compose or read * * In addition to the main signature, this method also has these signatures: + * * getAsync(callback?: (result: AsyncResult) => void): void; * * @param options Optional. An object literal that contains one or more of the following properties. @@ -9469,6 +12273,7 @@ declare namespace Office { * Errors: InvalidEndTime - The appointment end time is before its start time. * * In addition to the main signature, this method also has these signatures: + * * setAsync(recurrencePattern: Recurrence, callback?: (result: AsyncResult) => void): void; * * @param recurrencePattern A recurrence object. @@ -9576,7 +12381,7 @@ declare namespace Office { */ htmlBody?: string; /** - * An array of ReplyFormAttachments that are either file or item attachments. + * An array of {@link Office.ReplyFormAttachment} that are either file or item attachments. */ attachments?: ReplyFormAttachment[]; /** @@ -9765,6 +12570,7 @@ declare namespace Office { * Errors: Invalid date format - The date is not in an acceptable format. * * In addition to the main signature, this method also has these signatures: + * * setEndDate(date: string): void; * Where date is the end date of the recurring appointment series represented in the {@link https://www.iso.org/iso-8601-date-and-time-format.html | ISO 8601} date format: "YYYY-MM-DD". * @@ -9801,6 +12607,7 @@ declare namespace Office { * Errors: Invalid date format - The date is not in an acceptable format. * * In addition to the main signature, this method also has these signatures: + * * setStartDate(date: string): void; * Where date is the start date of the recurring appointment series represented in the {@link https://www.iso.org/iso-8601-date-and-time-format.html | ISO 8601} date format: "YYYY-MM-DD". * @@ -9839,6 +12646,7 @@ declare namespace Office { * Errors: Invalid time format - The time is not in an acceptable format. * * In addition to the main signature, this method also has these signatures: + * * setStartTime(time: string): void; * Where time is the start time of all instances represented by standard datetime string format: "THH:mm:ss:mmm". * @@ -9888,6 +12696,7 @@ declare namespace Office { * Applicable Outlook mode: Compose * * In addition to the main signature, this method also has these signatures: + * * getAsync(callback: (result: AsyncResult) => void): void; * * @param options An object literal that contains one or more of the following properties. @@ -9924,8 +12733,11 @@ declare namespace Office { * Errors: DataExceedsMaximumSize - The subject parameter is longer than 255 characters. * * In addition to the main signature, this method also has these signatures: + * * setAsync(subject: string): void; + * * setAsync(subject: string, options: AsyncContextOptions): void; + * * setAsync(subject: string, callback: (result: AsyncResult) => void): void; * * @param subject The subject of the appointment or message. The string is limited to 255 characters. @@ -10036,6 +12848,7 @@ declare namespace Office { * Applicable Outlook mode: Compose * * In addition to the main signature, this method also has these signatures: + * * getAsync(callback: (result: AsyncResult) => void): void; * * @param options An object literal that contains one or more of the following properties. @@ -10075,8 +12888,11 @@ declare namespace Office { * Errors: InvalidEndTime - The appointment end time is before the appointment start time. * * In addition to the main signature, this method also has these signatures: + * * setAsync(dateTime: Date): void; + * * setAsync(dateTime: Date, options: AsyncContextOptions): void; + * * setAsync(dateTime: Date, callback: (result: AsyncResult) => void): void; * * @param dateTime A date-time object in Coordinated Universal Time (UTC). @@ -10148,6 +12964,8 @@ declare namespace Office { } /** + * Information about the user associated with the mailbox. This includes their account type, display name, email adddress, and time zone. + * * [Api set: Mailbox 1.0] * * @remarks @@ -10262,7 +13080,7 @@ declare namespace OfficeExtension { pendingStatements: string[]; } - /** An abstract {@link Office.RequestContext} object that facilitates requests to the host Office application. The `Excel.run and `Word.run` methods provide a request context. */ + /** An abstract RequestContext object that facilitates requests to the host Office application. The `Excel.run and `Word.run` methods provide a request context. */ class ClientRequestContext { constructor(url?: string); diff --git a/types/react-pointable/index.d.ts b/types/react-pointable/index.d.ts index c69d537d55..0b83bdeb1d 100644 --- a/types/react-pointable/index.d.ts +++ b/types/react-pointable/index.d.ts @@ -1,4 +1,4 @@ -// Type definitions for react-pointable 1.1 +// Type definitions for react-pointable 1.2 // Project: https://github.com/MilllerTime/react-pointable // Definitions by: Stefan Fochler // Dibyo Majumdar @@ -13,14 +13,6 @@ export interface PointableProps extends React.HTMLAttributes, React.SVG tagName?: keyof ElementTagNameMap; touchAction?: TouchAction; elementRef?(el: HTMLElement|SVGElement): void; - onPointerMove?(evt: PointerEvent): void; - onPointerDown?(evt: PointerEvent): void; - onPointerUp?(evt: PointerEvent): void; - onPointerOver?(evt: PointerEvent): void; - onPointerOut?(evt: PointerEvent): void; - onPointerEnter?(evt: PointerEvent): void; - onPointerLeave?(evt: PointerEvent): void; - onPointerCancel?(evt: PointerEvent): void; } export default class Pointable extends React.Component { diff --git a/types/react-pointable/react-pointable-tests.tsx b/types/react-pointable/react-pointable-tests.tsx index 6331b88386..f905b8faa8 100644 --- a/types/react-pointable/react-pointable-tests.tsx +++ b/types/react-pointable/react-pointable-tests.tsx @@ -3,7 +3,7 @@ import Pointable from 'react-pointable'; class Test extends React.Component { elementRef(el: HTMLElement) {} - somePointerEvent(evt: PointerEvent) {} + somePointerEvent(evt: React.PointerEvent) {} render() { return ( diff --git a/types/react/global.d.ts b/types/react/global.d.ts index 8d6062b4bc..5afef3a17c 100644 --- a/types/react/global.d.ts +++ b/types/react/global.d.ts @@ -13,6 +13,7 @@ interface FocusEvent extends Event { } interface KeyboardEvent extends Event { } interface MouseEvent extends Event { } interface TouchEvent extends Event { } +interface PointerEvent extends Event { } interface TransitionEvent extends Event { } interface UIEvent extends Event { } interface WheelEvent extends Event { } diff --git a/types/react/index.d.ts b/types/react/index.d.ts index b4fb9415d3..fe432e8a42 100644 --- a/types/react/index.d.ts +++ b/types/react/index.d.ts @@ -1,4 +1,4 @@ -// Type definitions for React 16.3 +// Type definitions for React 16.4 // Project: http://facebook.github.io/react/ // Definitions by: Asana // AssureSign @@ -31,6 +31,7 @@ type NativeFocusEvent = FocusEvent; type NativeKeyboardEvent = KeyboardEvent; type NativeMouseEvent = MouseEvent; type NativeTouchEvent = TouchEvent; +type NativePointerEvent = PointerEvent; type NativeTransitionEvent = TransitionEvent; type NativeUIEvent = UIEvent; type NativeWheelEvent = WheelEvent; @@ -590,6 +591,18 @@ declare namespace React { nativeEvent: NativeDragEvent; } + interface PointerEvent extends MouseEvent { + pointerId: number; + pressure: number; + tiltX: number; + tiltY: number; + width: number; + height: number; + pointerType: 'mouse' | 'pen' | 'touch'; + isPrimary: boolean; + nativeEvent: NativePointerEvent; + } + interface FocusEvent extends SyntheticEvent { nativeEvent: NativeFocusEvent; relatedTarget: EventTarget; @@ -711,6 +724,7 @@ declare namespace React { type KeyboardEventHandler = EventHandler>; type MouseEventHandler = EventHandler>; type TouchEventHandler = EventHandler>; + type PointerEventHandler = EventHandler>; type UIEventHandler = EventHandler>; type WheelEventHandler = EventHandler>; type AnimationEventHandler = EventHandler>; @@ -898,6 +912,28 @@ declare namespace React { onTouchStart?: TouchEventHandler; onTouchStartCapture?: TouchEventHandler; + // Pointer Events + onPointerDown?: PointerEventHandler; + onPointerDownCapture?: PointerEventHandler; + onPointerMove?: PointerEventHandler; + onPointerMoveCapture?: PointerEventHandler; + onPointerUp?: PointerEventHandler; + onPointerUpCapture?: PointerEventHandler; + onPointerCancel?: PointerEventHandler; + onPointerCancelCapture?: PointerEventHandler; + onPointerEnter?: PointerEventHandler; + onPointerEnterCapture?: PointerEventHandler; + onPointerLeave?: PointerEventHandler; + onPointerLeaveCapture?: PointerEventHandler; + onPointerOver?: PointerEventHandler; + onPointerOverCapture?: PointerEventHandler; + onPointerOut?: PointerEventHandler; + onPointerOutCapture?: PointerEventHandler; + onGotPointerCapture?: PointerEventHandler; + onGotPointerCaptureCapture?: PointerEventHandler; + onLostPointerCapture?: PointerEventHandler; + onLostPointerCaptureCapture?: PointerEventHandler; + // UI Events onScroll?: UIEventHandler; onScrollCapture?: UIEventHandler; diff --git a/types/sequelize/index.d.ts b/types/sequelize/index.d.ts index 2772eaa905..0d9a96bfc4 100644 --- a/types/sequelize/index.d.ts +++ b/types/sequelize/index.d.ts @@ -5262,6 +5262,11 @@ declare namespace sequelize { * Set to true or a string with the attribute name you want to use to enable. */ version?: boolean | string; + + /** + * Throws an error when no records found + */ + rejectOnError?: boolean | Error; } /** diff --git a/types/webpack/index.d.ts b/types/webpack/index.d.ts index 0339a4ebb5..55d7dbd801 100644 --- a/types/webpack/index.d.ts +++ b/types/webpack/index.d.ts @@ -12,6 +12,7 @@ // Jason Cheatham // Dennis George // Christophe Hurpeau +// ZSkycat // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped // TypeScript Version: 2.3 @@ -349,14 +350,16 @@ declare namespace webpack { type ExternalsFunctionElement = (context: any, request: any, callback: (error: any, result: any) => void) => any; interface Node { - console?: boolean; + console?: boolean | 'mock'; + process?: boolean | 'mock'; global?: boolean; - process?: boolean; - Buffer?: boolean; - __filename?: boolean | string; - __dirname?: boolean | string; - [nodeBuiltin: string]: boolean | string | undefined; + __filename?: boolean | 'mock'; + __dirname?: boolean | 'mock'; + Buffer?: boolean | 'mock'; + setImmediate?: boolean | 'mock' | 'empty'; + [nodeBuiltin: string]: boolean | 'mock' | 'empty' | undefined; } + interface NewLoader { loader: string; options?: { [name: string]: any };