Options
All
  • Public
  • Public/Protected
  • All
Menu

Class App

Hierarchy

  • App

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

  • new App(client: HttpClient, pod: Readonly<PODModel & { acceptanceText?: string; admins: string[]; allowUserUploads: boolean; brandingColor?: string; category?: string; collaborators: string[]; extendedDescription?: string; homepageUrl: string; invitationText?: string; inviteOnly: boolean; invites?: string[]; logoUrl: string; name: string; organization: string; owner: string; participants: string[]; privacyPolicy: string; published: boolean; rejectionText?: string; shortDescription: string; termsAndConditions: string }>): App

  • Parameters

    • client: HttpClient
    • pod: Readonly<PODModel & { acceptanceText?: string; admins: string[]; allowUserUploads: boolean; brandingColor?: string; category?: string; collaborators: string[]; extendedDescription?: string; homepageUrl: string; invitationText?: string; inviteOnly: boolean; invites?: string[]; logoUrl: string; name: string; organization: string; owner: string; participants: string[]; privacyPolicy: string; published: boolean; rejectionText?: string; shortDescription: string; termsAndConditions: string }>

    Returns App

Properties

Private #client

#client: HttpClient

Optional Readonly acceptanceText

acceptanceText: string

Text shown to the user after accepting the app's invitation.

Readonly admins

admins: IdentityId[]

Readonly allowUserUploads

allowUserUploads: boolean

Allow non-admin users to upload documents.

Optional Readonly brandingColor

brandingColor: string

The app's branding color in RGB hex format (e.g. #ff4212).

Optional Readonly category

category: string

Text describing the category of the app (e.g., health, finance) that can be used to search for the app.

Readonly collaborators

collaborators: IdentityId[]

Identities that can view participation of the app and modify un-privileged fields.

Readonly createdAt

createdAt: Date

The number of seconds since the Unix epoch when this model was created

Optional Readonly extendedDescription

extendedDescription: string

Readonly homepageUrl

homepageUrl: string

The app publisher's homepage URL.

Readonly id

id: AppId

The model's unique ID.

Optional Readonly invitationText

invitationText: string

Text shown to the user when viewing the app's invite page.

Readonly inviteOnly

inviteOnly: boolean

If true, only invited Identities may participate in the app.

Readonly invites

invites: IdentityId[]

Identities invited to participate in this app.

Readonly logoUrl

logoUrl: string

A URL pointing to (or containing) the app's logo.

Readonly name

name: string

Readonly organization

organization: string

The name of the app publisher's organization.

Readonly owner

owner: IdentityId

The Identity that created the app.

Readonly participants

participants: IdentityId[]

The set of identities that are currently authorizing this app.

Readonly privacyPolicy

privacyPolicy: string

The privacy policy presented to the user when joining the app.

Readonly published

published: boolean

Whether this app has been published. Permissions may not be modified after publishing,

Optional Readonly rejectionText

rejectionText: string

Text shown to the user after rejecting the app's invitation.

Readonly shortDescription

shortDescription: string

Readonly termsAndConditions

termsAndConditions: string

The terms and conditions presented to the user when joining the app.

Methods

createPermission

  • Creates a new permission that this app will request from users. The new permission will be added to this.permissions.

    Parameters

    Returns Promise<Permission>

delete

  • delete(): Promise<void>

  • Returns Promise<void>

deletePermission

  • deletePermission(permissionId: PermissionId): Promise<void>

  • Deletes a permission from this app, revoking any access made by granting permission. will be removed from this.permissions.

    Parameters

    Returns Promise<void>

getIdentity

  • Returns Promise<Identity>

listPermissions

  • listPermissions(filter?: Partial<{ pageSize: number; pageToken: string }>): Promise<Page<Permission>>

  • Returns the permissions associated with this app.

    Parameters

    • Optional filter: Partial<{ pageSize: number; pageToken: string }>

    Returns Promise<Page<Permission>>

update

updateIdentity

Generated using TypeDoc