@espressif/rainmaker-base-cdf
    Preparing search index...

    Class ESPGroupSharingRequest

    Represents a group sharing request in the system.

    This class encapsulates the details of a request made by a user for sharing a group. It includes the status of the request, relevant group information, and user details related to the request.

    Implements

    Index

    Constructors

    Properties

    groupIds: string[]

    A list of group IDs associated with the sharing request.

    groupnames: string[]

    A list of group names associated with the sharing request.

    id: string

    The unique identifier for the group sharing request.

    metadata: Record<string, any>

    Additional metadata associated with the group sharing request.

    newRole: string

    The new role to be assigned to the user in the group as part of the sharing request.

    primaryUsername: string

    The primary username associated with the group sharing request.

    The current status of the group sharing request (e.g., pending, accepted, rejected).

    timestamp: number

    The timestamp indicating when the group sharing request was created.

    transfer: boolean

    A flag indicating whether the group sharing request involves a transfer.

    username: string

    The username of the user who created the group sharing request.

    Methods

    • Returns Promise<ESPAPIResponse>

    • Declines a group sharing request for the user.

      Returns Promise<ESPAPIResponse>

      A promise that resolves to a success response indicating the request was declined.

    • Removes a group sharing request for the user.

      Returns Promise<ESPAPIResponse>

      A promise that resolves to a success response indicating the request was removed.