@inweb/client
    Preparing search index...

    Class Member

    Provides properties and methods for obtaining information about a user who has access to the project.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    headers path

    Accessors

    data id role type user

    Methods

    checkout delete save update

    Constructors

    • Parameters

      • data: any

        Raw member data received from the server. For more information, see Open Cloud Projects API.

      • projectId: string

        Owner project ID.

      • httpClient: IHttpClient

        HTTP client instance used to send requests to the REST API server.

      Returns Member

    Properties

    headers: HeadersInit

    Endpoint-specific HTTP headers for the GET, POST, PUT and DELETE requests. You can add custom headers at any time.

    path: string

    Endpoint API path relative to the REST API server URL.

    Accessors

    • get data(): any

      Raw member data received from the server. For more information, see Open Cloud Projects API.

      Returns any

    • get id(): string

      Unique member ID.

      Returns string

    • get role(): string

      Member role name in the project. See Project.getRoles() for list of project roles.

      Returns string

    • get type(): string

      Member type. Can be owner or user.

      Returns string

    Methods

    • Reloads member data from the server.

      Returns Promise<Member>

    • Removes a member from the project.

      Returns Promise<any>

      Returns the raw data of a deleted member. For more information, see Open Cloud Projects API.

    • Saves member properties changes to the server. Call this method to update member data on the server after any property changes.

      Returns Promise<Member>

    • Updates member data on the server.

      Parameters

      Returns Promise<Member>

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods