// Type definitions for avoscloud-sdk 0.6.10 // Project: https://leancloud.cn/ // Definitions by: Wu Jun // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped declare module "avoscloud-sdk" { namespace AV { var applicationId: string; var applicationKey: string; var masterKey: string; interface SuccessOption { success?: Function; } interface ErrorOption { error?: Function; } interface SuccessFailureOptions extends SuccessOption, ErrorOption { } interface WaitOption { /** * Set to true to wait for the server to confirm success * before triggering an event. */ wait?: boolean; } interface UseMasterKeyOption { /** * In Cloud Code and Node only, causes the Master Key to be used for this request. */ useMasterKey?: boolean; } interface SilentOption { /** * Set to true to avoid firing the event. */ silent?: boolean; } /** * A Promise is returned by async methods as a hook to provide callbacks to be * called when the async task is fulfilled. * *

Typical usage would be like:

     *    query.find().then(function(results) {
     *      results[0].set("foo", "bar");
     *      return results[0].saveAsync();
     *    }).then(function(result) {
     *      console.log("Updated " + result.id);
     *    });
     *

* * @see AV.Promise.prototype.then * @class */ interface IPromise { then(resolvedCallback: (value: T) => IPromise, rejectedCallback?: (reason: any) => IPromise): IPromise; then(resolvedCallback: (value: T) => U, rejectedCallback?: (reason: any) => IPromise): IPromise; then(resolvedCallback: (value: T) => U, rejectedCallback?: (reason: any) => U): IPromise; } class Promise { static as(resolvedValue: U): Promise; static error(error: U): Promise; static is(possiblePromise: any): Boolean; static when(promises: Promise[]): Promise; always(callback: Function): Promise; done(callback: Function): Promise; fail(callback: Function): Promise; reject(error: any): void; resolve(result: any): void; then(resolvedCallback: (value: T) => Promise, rejectedCallback?: (reason: any) => Promise): IPromise; then(resolvedCallback: (value: T) => U, rejectedCallback?: (reason: any) => IPromise): IPromise; then(resolvedCallback: (value: T) => U, rejectedCallback?: (reason: any) => U): IPromise; } interface IBaseObject { toJSON(): any; } class BaseObject implements IBaseObject { toJSON(): any; } /** * Creates a new ACL. * If no argument is given, the ACL has no permissions for anyone. * If the argument is a AV.User, the ACL will have read and write * permission for only that user. * If the argument is any other JSON object, that object will be interpretted * as a serialized ACL created with toJSON(). * @see AV.Object#setACL * @class * *

An ACL, or Access Control List can be added to any * AV.Object to restrict access to only a subset of users * of your application.

*/ class ACL extends BaseObject { permissionsById: any; constructor(arg1?: any); setPublicReadAccess(allowed: boolean): void; getPublicReadAccess(): boolean; setPublicWriteAccess(allowed: boolean): void; getPublicWriteAccess(): boolean; setReadAccess(userId: User, allowed: boolean): void; getReadAccess(userId: User): boolean; setReadAccess(userId: string, allowed: boolean): void; getReadAccess(userId: string): boolean; setRoleReadAccess(role: Role, allowed: boolean): void; setRoleReadAccess(role: string, allowed: boolean): void; getRoleReadAccess(role: Role): boolean; getRoleReadAccess(role: string): boolean; setRoleWriteAccess(role: Role, allowed: boolean): void; setRoleWriteAccess(role: string, allowed: boolean): void; getRoleWriteAccess(role: Role): boolean; getRoleWriteAccess(role: string): boolean; setWriteAccess(userId: User, allowed: boolean): void; setWriteAccess(userId: string, allowed: boolean): void; getWriteAccess(userId: User): boolean; getWriteAccess(userId: string): boolean; } /** * A AV.File is a local representation of a file that is saved to the AV * cloud. * @class * @param name {String} The file's name. This will be prefixed by a unique * value once the file has finished saving. The file name must begin with * an alphanumeric character, and consist of alphanumeric characters, * periods, spaces, underscores, or dashes. * @param data {Array} The data for the file, as either: * 1. an Array of byte value Numbers, or * 2. an Object like { base64: "..." } with a base64-encoded String. * 3. a File object selected with a file upload control. (3) only works * in Firefox 3.6+, Safari 6.0.2+, Chrome 7+, and IE 10+. * For example:
     * var fileUploadControl = $("#profilePhotoFileUpload")[0];
     * if (fileUploadControl.files.length > 0) {
     *   var file = fileUploadControl.files[0];
     *   var name = "photo.jpg";
     *   var AVFile = new AV.File(name, file);
     *   AVFile.save().then(function() {
     *     // The file has been saved to AV.
     *   }, function(error) {
     *     // The file either could not be read, or could not be saved to AV.
     *   });
     * }
* @param type {String} Optional Content-Type header to use for the file. If * this is omitted, the content type will be inferred from the name's * extension. */ class File { constructor(name: string, data: any, type?: string); name(): string; url(): string; save(options?: SuccessFailureOptions): Promise; } /** * Creates a new GeoPoint with any of the following forms:
* 
     *   new GeoPoint(otherGeoPoint)
     *   new GeoPoint(30, 30)
     *   new GeoPoint([30, 30])
     *   new GeoPoint({latitude: 30, longitude: 30})
     *   new GeoPoint()  // defaults to (0, 0)
     *
* @class * *

Represents a latitude / longitude point that may be associated * with a key in a AVObject or used as a reference point for geo queries. * This allows proximity-based queries on the key.

* *

Only one key in a class may contain a GeoPoint.

* *

Example:

     *   var point = new AV.GeoPoint(30.0, -20.0);
     *   var object = new AV.Object("PlaceObject");
     *   object.set("location", point);
     *   object.save();

*/ class GeoPoint extends BaseObject { latitude: number; longitude: number; constructor(arg1?: any, arg2?: any); current(options?: SuccessFailureOptions): GeoPoint; radiansTo(point: GeoPoint): number; kilometersTo(point: GeoPoint): number; milesTo(point: GeoPoint): number; } /** * A class that is used to access all of the children of a many-to-many relationship. * Each instance of AV.Relation is associated with a particular parent object and key. */ class Relation extends BaseObject { parent: Object; key: string; targetClassName: string; constructor(parent?: Object, key?: string); //Adds a AV.Object or an array of AV.Objects to the relation. add(object: Object): void; // Returns a AV.Query that is limited to objects in this relation. query(): Query; // Removes a AV.Object or an array of AV.Objects from this relation. remove(object: Object): void; } /** * Creates a new model with defined attributes. A client id (cid) is * automatically generated and assigned for you. * *

You won't normally call this method directly. It is recommended that * you use a subclass of AV.Object instead, created by calling * extend.

* *

However, if you don't want to use a subclass, or aren't sure which * subclass is appropriate, you can use this form:

     *     var object = new AV.Object("ClassName");
     *
* That is basically equivalent to:
     *     var MyClass = AV.Object.extend("ClassName");
     *     var object = new MyClass();
     *

* * @param {Object} attributes The initial set of data to store in the object. * @param {Object} options A set of Backbone-like options for creating the * object. The only option currently supported is "collection". * @see AV.Object.extend * * @class * *

The fundamental unit of AV data, which implements the Backbone Model * interface.

*/ class Object extends BaseObject { id: any; createdAt:any; updatedAt:any; attributes: any; cid: string; changed: boolean; className: string; constructor(className?: string, options?: any); constructor(attributes?: string[], options?: any); static extend(className: string, protoProps?: any, classProps?: any): any; static fetchAll(list: Object[], options: SuccessFailureOptions): Promise; static fetchAllIfNeeded(list: Object[], options: SuccessFailureOptions): Promise; static destroyAll(list: Object[], options?: Object.DestroyAllOptions): Promise; static saveAll(list: Object[], options?: Object.SaveAllOptions): Promise; initialize(): void; add(attr: string, item: any): Object; addUnique(attr: string, item: any): any; change(options: any): Object; changedAttributes(diff: any): boolean; clear(options: any): any; clone(): Object; destroy(options?: Object.DestroyOptions): Promise; dirty(attr: String): boolean; dirtyKeys(): string[]; escape(attr: string): string; existed(): boolean; fetch(options?: Object.FetchOptions): Promise; get(attr: string): any; getACL(): ACL; getObjectId(): string; has(attr: string): boolean; hasChanged(attr: string): boolean; increment(attr: string, amount?: number): any; isValid(): boolean; op(attr: string): any; previous(attr: string): any; previousAttributes(): any; relation(attr: string): Relation; remove(attr: string, item: any): any; save(options?: Object.SaveOptions, arg2?: any, arg3?: any): Promise; set(key: string, value: any, options?: Object.SetOptions): boolean; setACL(acl: ACL, options?: SuccessFailureOptions): boolean; unset(attr: string, options?: any): any; validate(attrs: any, options?: SuccessFailureOptions): boolean; } namespace Object { interface DestroyOptions extends SuccessFailureOptions, WaitOption, UseMasterKeyOption { } interface DestroyAllOptions extends SuccessFailureOptions, UseMasterKeyOption { } interface FetchOptions extends SuccessFailureOptions, UseMasterKeyOption { } interface SaveOptions extends SuccessFailureOptions, SilentOption, UseMasterKeyOption, WaitOption { } interface SaveAllOptions extends SuccessFailureOptions, UseMasterKeyOption { } interface SetOptions extends ErrorOption, SilentOption { promise?: any; } } /** * Every AV application installed on a device registered for * push notifications has an associated Installation object. */ class Installation extends Object { badge: any; channels: string[]; timeZone: any; deviceType: string; pushType: string; installationId: string; deviceToken: string; channelUris: string; appName: string; appVersion: string; AVVersion: string; appIdentifier: string; } /** * Creates a new instance with the given models and options. Typically, you * will not call this method directly, but will instead make a subclass using * AV.Collection.extend. * * @param {Array} models An array of instances of AV.Object. * * @param {Object} options An optional object with Backbone-style options. * Valid options are:
    *
  • model: The AV.Object subclass that this collection contains. *
  • query: An instance of AV.Query to use when fetching items. *
  • comparator: A string property name or function to sort by. *
* * @see AV.Collection.extend * * @class * *

Provides a standard collection class for our sets of models, ordered * or unordered. For more information, see the * Backbone * documentation.

*/ class Collection extends Events implements IBaseObject { model: Object; models: Object[]; query: Query; comparator: (object: Object) => any; constructor(models?: Object[], options?: Collection.Options); static extend(instanceProps: any, classProps: any): any; initialize(): void; add(models: any[], options?: Collection.AddOptions): Collection; at(index: number): Object; fetch(options?: Collection.FetchOptions): Promise; create(model: Object, options?: Collection.CreateOptions): Object; get(id: string): Object; getByCid(cid: any): any; pluck(attr: string): any[]; remove(model: any, options?: Collection.RemoveOptions): Collection; remove(models: any[], options?: Collection.RemoveOptions): Collection; reset(models: any[], options?: Collection.ResetOptions): Collection; sort(options?: Collection.SortOptions): Collection; toJSON(): any; } namespace Collection { interface Options { model?: Object; query?: Query; comparator?: string; } interface AddOptions extends SilentOption { /** * The index at which to add the models. */ at?: number; } interface CreateOptions extends SuccessFailureOptions, WaitOption, SilentOption, UseMasterKeyOption { } interface FetchOptions extends SuccessFailureOptions, SilentOption, UseMasterKeyOption { } interface RemoveOptions extends SilentOption { } interface ResetOptions extends SilentOption { } interface SortOptions extends SilentOption { } } /** * @class * *

AV.Events is a fork of Backbone's Events module, provided for your * convenience.

* *

A module that can be mixed in to any object in order to provide * it with custom events. You may bind callback functions to an event * with `on`, or remove these functions with `off`. * Triggering an event fires all callbacks in the order that `on` was * called. * * 

     *     var object = {};
     *     _.extend(object, AV.Events);
     *     object.on('expand', function(){ alert('expanded'); });
     *     object.trigger('expand');

* *

For more information, see the * Backbone * documentation.

*/ class Events { static off(events: string[], callback?: Function, context?: any): Events; static on(events: string[], callback?: Function, context?: any): Events; static trigger(events: string[]): Events; static bind(): Events; static unbind(): Events; on(eventName: string, callback?: Function, context?: any): Events; off(eventName?: string, callback?: Function, context?: any): Events; trigger(eventName: string, ...args: any[]): Events; bind(eventName: string, callback: Function, context?: any): Events; unbind(eventName?: string, callback?: Function, context?: any): Events; } /** * Creates a new AV AV.Query for the given AV.Object subclass. * @param objectClass - * An instance of a subclass of AV.Object, or a AV className string. * @class * *

AV.Query defines a query that is used to fetch AV.Objects. The * most common use case is finding all objects that match a query through the * find method. For example, this sample code fetches all objects * of class MyClass. It calls a different function depending on * whether the fetch succeeded or not. * * 

     * var query = new AV.Query(MyClass);
     * query.find({
     *   success: function(results) {
     *     // results is an array of AV.Object.
     *   },
     *
     *   error: function(error) {
     *     // error is an instance of AV.Error.
     *   }
     * });

* *

A AV.Query can also be used to retrieve a single object whose id is * known, through the get method. For example, this sample code fetches an * object of class MyClass and id myId. It calls a * different function depending on whether the fetch succeeded or not. * * 

     * var query = new AV.Query(MyClass);
     * query.get(myId, {
     *   success: function(object) {
     *     // object is an instance of AV.Object.
     *   },
     *
     *   error: function(object, error) {
     *     // error is an instance of AV.Error.
     *   }
     * });

* *

A AV.Query can also be used to count the number of objects that match * the query without retrieving all of those objects. For example, this * sample code counts the number of objects of the class MyClass * 

     * var query = new AV.Query(MyClass);
     * query.count({
     *   success: function(number) {
     *     // There are number instances of MyClass.
     *   },
     *
     *   error: function(error) {
     *     // error is an instance of AV.Error.
     *   }
     * });

*/ class Query extends BaseObject { objectClass: any; className: string; constructor(objectClass: any); static and(...var_args: Query[]): Query; static or(...var_args: Query[]): Query; addAscending(key: string): Query; addAscending(key: string[]): Query; addDescending(key: string): Query; addDescending(key: string[]): Query; ascending(key: string): Query; ascending(key: string[]): Query; collection(items?: Object[], options?: Collection.Options): Collection; containedIn(key: string, values: any[]): Query; contains(key: string, substring: string): Query; containsAll(key: string, values: any[]): Query; count(options?: Query.CountOptions): Promise; descending(key: string): Query; descending(key: string[]): Query; doesNotExist(key: string): Query; doesNotMatchKeyInQuery(key: string, queryKey: string, query: Query): Query; doesNotMatchQuery(key: string, query: Query): Query; each(callback: Function, options?: SuccessFailureOptions): Promise; endsWith(key: string, suffix: string): Query; equalTo(key: string, value: any): Query; exists(key: string): Query; find(options?: Query.FindOptions): Promise; first(options?: Query.FirstOptions): Promise; get(objectId: string, options?: Query.GetOptions): Promise; greaterThan(key: string, value: any): Query; greaterThanOrEqualTo(key: string, value: any): Query; include(key: string): Query; include(keys: string[]): Query; lessThan(key: string, value: any): Query; lessThanOrEqualTo(key: string, value: any): Query; limit(n: number): Query; matches(key: string, regex: RegExp, modifiers: any): Query; matchesKeyInQuery(key: string, queryKey: string, query: Query): Query; matchesQuery(key: string, query: Query): Query; near(key: string, point: GeoPoint): Query; notContainedIn(key: string, values: any[]): Query; notEqualTo(key: string, value: any): Query; select(...keys: string[]): Query; skip(n: number): Query; startsWith(key: string, prefix: string): Query; withinGeoBox(key: string, southwest: GeoPoint, northeast: GeoPoint): Query; withinKilometers(key: string, point: GeoPoint, maxDistance: number): Query; withinMiles(key: string, point: GeoPoint, maxDistance: number): Query; withinRadians(key: string, point: GeoPoint, maxDistance: number): Query; } namespace Query { interface CountOptions extends SuccessFailureOptions, UseMasterKeyOption { } interface FindOptions extends SuccessFailureOptions, UseMasterKeyOption { } interface FirstOptions extends SuccessFailureOptions, UseMasterKeyOption { } interface GetOptions extends SuccessFailureOptions, UseMasterKeyOption { } } /** * Represents a Role on the AV server. Roles represent groupings of * Users for the purposes of granting permissions (e.g. specifying an ACL * for an Object). Roles are specified by their sets of child users and * child roles, all of which are granted any permissions that the parent * role has. * *

Roles must have a name (which cannot be changed after creation of the * role), and must specify an ACL.

* @class * A AV.Role is a local representation of a role persisted to the AV * cloud. */ class Role extends Object { constructor(name: string, acl: ACL); getRoles(): Relation; getUsers(): Relation; getName(): string; setName(name: string, options?: SuccessFailureOptions): any; } /** * @class * *

A AV.User object is a local representation of a user persisted to the * AV cloud. This class is a subclass of a AV.Object, and retains the * same functionality of a AV.Object, but also extends it with various * user specific methods, like authentication, signing up, and validation of * uniqueness.

*/ class User extends Object { static current(): User; static signUp(username: string, password: string, attrs: any, options?: SuccessFailureOptions): Promise; static logIn(username: string, password: string, options?: SuccessFailureOptions): Promise; static logOut(): Promise; static allowCustomUserClass(isAllowed: boolean): void; static become(sessionToken: string, options?: SuccessFailureOptions): Promise; static requestPasswordReset(email: string, options?: SuccessFailureOptions): Promise; signUp(attrs: any, options?: SuccessFailureOptions): Promise; logIn(options?: SuccessFailureOptions): Promise; fetch(options?: SuccessFailureOptions): Promise; save(arg1?: any, arg2?: any, arg3?: any): Promise; authenticated(): boolean; isCurrent(): boolean; getEmail(): string; setEmail(email: string, options: SuccessFailureOptions): boolean; getUsername(): string; setUsername(username: string, options?: SuccessFailureOptions): boolean; setPassword(password: string, options?: SuccessFailureOptions): boolean; getSessionToken(): string; } namespace Analytics { function track(name: string, dimensions: any):Promise; } class Error { code: ErrorCode; message: string; constructor(code: ErrorCode, message: string); } enum ErrorCode { OTHER_CAUSE = -1, INTERNAL_SERVER_ERROR = 1, CONNECTION_FAILED = 100, OBJECT_NOT_FOUND = 101, INVALID_QUERY = 102, INVALID_CLASS_NAME = 103, MISSING_OBJECT_ID = 104, INVALID_KEY_NAME = 105, INVALID_POINTER = 106, INVALID_JSON = 107, COMMAND_UNAVAILABLE = 108, NOT_INITIALIZED = 109, INCORRECT_TYPE = 111, INVALID_CHANNEL_NAME = 112, PUSH_MISCONFIGURED = 115, OBJECT_TOO_LARGE = 116, OPERATION_FORBIDDEN = 119, CACHE_MISS = 120, INVALID_NESTED_KEY = 121, INVALID_FILE_NAME = 122, INVALID_ACL = 123, TIMEOUT = 124, INVALID_EMAIL_ADDRESS = 125, MISSING_CONTENT_TYPE = 126, MISSING_CONTENT_LENGTH = 127, INVALID_CONTENT_LENGTH = 128, FILE_TOO_LARGE = 129, FILE_SAVE_ERROR = 130, DUPLICATE_VALUE = 137, INVALID_ROLE_NAME = 139, EXCEEDED_QUOTA = 140, SCRIPT_FAILED = 141, VALIDATION_ERROR = 142, INVALID_IMAGE_DATA = 150, UNSAVED_FILE_ERROR = 151, INVALID_PUSH_TIME_ERROR = 152, FILE_DELETE_ERROR = 153, REQUEST_LIMIT_EXCEEDED = 155, INVALID_EVENT_NAME = 160, USERNAME_MISSING = 200, PASSWORD_MISSING = 201, USERNAME_TAKEN = 202, EMAIL_TAKEN = 203, EMAIL_MISSING = 204, EMAIL_NOT_FOUND = 205, SESSION_MISSING = 206, MUST_CREATE_USER_THROUGH_SIGNUP = 207, ACCOUNT_ALREADY_LINKED = 208, INVALID_SESSION_TOKEN = 209, LINKED_ID_MISSING = 250, INVALID_LINKED_SESSION = 251, UNSUPPORTED_SERVICE = 252, AGGREGATE_ERROR = 600, FILE_READ_ERROR = 601, X_DOMAIN_REQUEST = 602 } /** * @class * A AV.Op is an atomic operation that can be applied to a field in a * AV.Object. For example, calling object.set("foo", "bar") * is an example of a AV.Op.Set. Calling object.unset("foo") * is a AV.Op.Unset. These operations are stored in a AV.Object and * sent to the server as part of object.save() operations. * Instances of AV.Op should be immutable. * * You should not create subclasses of AV.Op or instantiate AV.Op * directly. */ namespace Op { interface BaseOperation extends IBaseObject { objects(): any[]; } interface Add extends BaseOperation { } interface AddUnique extends BaseOperation { } interface Increment extends IBaseObject { amount: number; } interface Relation extends IBaseObject { added(): Object[]; removed: Object[]; } interface Set extends IBaseObject { value(): any; } interface Unset extends IBaseObject { } } /** * Contains functions to deal with Push in AV * @name AV.Push * @namespace */ namespace Push { function send(data: PushData, options?: SendOptions): Promise; interface PushData { channels?: string[]; push_time?: Date; expiration_time?: Date; expiration_interval?: number; where?: Query; data?: any; alert?: string; badge?: string; sound?: string; title?: string; } interface SendOptions { success?: () => void; error?: (error: Error) => void; } } /** * Call this method first to set up your authentication tokens for AV. * @param {String} applicationId Your Application ID. * @param {String} applicationKey Your Application Key. * @param {String} masterKey (optional) Your Application Master Key. (Node.js only!) */ function initialize(applicationId: string, applicationKey: string, masterKey?: string): void; } export = AV; } declare module 'leanengine' { import alias = require('avoscloud-sdk'); export = alias; }