Project

Instance methods:

Static methods and properties:

Instance Methods

constructor: Project(credentials, id)

Arguments

  1. credentials (Credentials): Valid credentials corresponding to the current user
  2. id (String): The project's ID

Returns

(Project) A Project instance

getDataTable()

See DataTable#constructor

new Project(credentials, id).getDataTable()

is equivalent to

new DataTable(credentials, id)

delete()

Returns

TODO

listUsers()

Returns

(Promise --> Object) Resolves to the serialized API response

share(email, permission)

Arguments

  1. email (String): Email address of the user to share with
  2. permission (Permission): Level of access to grant the user

NOTE: Node SDK only.

unshare(userId)

Arguments

  1. userId (String): User ID (see User.fetchProfile). Not the Maker ID or email address.

NOTE: Node SDK only.

Static Methods and Properties

listProjects(credentials)

Arguments

  1. credentials (Credentials): Valid credentials corresponding to the current user

Returns

(Promise --> Object) Resolves to the serialized API response

createProject(credentials, name, [options])

Arguments

  1. credentials (Credentials): Valid credentials corresponding to the current user
  2. name (String): The name of the new project

  3. options (Object = { app: String })

    app (default: "blank"): The base app for the project

Returns

(Promise --> Object) Resolves to the serialized API response

serialize

Set to override how the SDK serializes single-entity project API responses, such as createProject.

By default, this will return an Object with the structure:

type ProjectResponse = {
  id: String,
  name: String,
  creatorId: String,
  creatorName: String,
  timeCreated: Date,
  timeUpdated: Date,
}

See Serialization for more information.

serializeList

Set to override how the SDK serializes multiple-entity project API responses, such as listProjects.

By default, this will return an Object with the structure:

type ProjectsResponse = {
  entities: ProjectResponse[],
}

See Serialization for more information.

results matching ""

    No results matching ""