NDEx JavaScript Client API Reference - v0.6.0-alpha.5
    Preparing search index...

    Interface SharingMemberRequest

    Request object for sharing member operations

    This interface defines the structure for requests that manage file sharing permissions. It combines file identification with member permission management in a single request.

    interface SharingMemberRequest {
        files: Record<string, NDExFileType>;
        members: Record<string, Permission | null>;
    }
    Index

    Properties

    Properties

    files: Record<string, NDExFileType>

    Object mapping file UUIDs to their corresponding file types

    Each key represents the UUID of a file to be shared, and the value indicates what type of file it is (NETWORK, FOLDER, or SHORTCUT)

    {
    "12345678-1234-1234-1234-123456789abc": "NETWORK",
    "87654321-4321-4321-4321-876543210fed": "FOLDER"
    }
    members: Record<string, Permission | null>

    Object mapping member UUIDs to their permission levels

    Each key represents the UUID of a user or member who should receive explicit permissions, and the value is the type of permission they should have. If the permission value is null, the existing file permission for the member will be revoked.

    {
    "user1-uuid-1234-5678-9abc-def012345678": "READ",
    "user2-uuid-8765-4321-fedc-ba0987654321": "WRITE",
    "user3-uuid-1111-2222-3333-444444444444": null // This will revoke permissions
    }