@bzr/bazaar
    Preparing search index...

    Class PermissionsAPIInternal

    The class that encapsulates the permissions API

    Index

    Constructors

    constructor

    Properties

    granted links

    Methods

    create delete list

    Constructors

    Properties

    granted: {
        delete: (grantedPermissionId: string) => Promise<BazaarMessage>;
        list: (query?: GrantedPermissionsQuery) => Promise<GrantedPermission[]>;
        subscribe: (
            query?: GrantedPermissionsQuery,
            listener: SubscribeListener<GrantedPermission>,
        ) => Promise<() => Promise<BazaarMessage>>;
    } = ...

    Granted Permissions

    links: {
        create: (
            permission: PermissionTemplate,
            description?: string,
            limit?: number,
        ) => Promise<
            {
                description: string;
                id: string;
                limit: number;
                permission: PermissionTemplate;
                url: string;
                users: string[];
            },
        >;
        delete: (linkId: string) => Promise<BazaarMessage>;
        list: (query?: LinksQuery) => Promise<Link[]>;
        subscribe: (
            query?: LinksQuery,
            listener: SubscribeListener<Link>,
        ) => Promise<() => Promise<BazaarMessage>>;
    } = ...

    Links

    Type Declaration

    • create: (
          permission: PermissionTemplate,
          description?: string,
          limit?: number,
      ) => Promise<
          {
              description: string;
              id: string;
              limit: number;
              permission: PermissionTemplate;
              url: string;
              users: string[];
          },
      >

      Creates a link

    • delete: (linkId: string) => Promise<BazaarMessage>

      Deletes a link

    • list: (query?: LinksQuery) => Promise<Link[]>

      Lists links

    • subscribe: (
          query?: LinksQuery,
          listener: SubscribeListener<Link>,
      ) => Promise<() => Promise<BazaarMessage>>

      Subscribes to links changes

    Methods

    • Creates permission for a collection query and a user.

      Parameters

      • permission: NewPermission

        "Specifies the permission to be created"

      • notification: SharingNotification = noSharingNotification

        "Specifies if/how the user is notified. Defaults to {createNotification: false, sendMessage: SendNotification.Never}"

      Returns Promise<{ id: string }>

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods