Function Files

The Files function is a TypeScript module that provides methods for interacting with files, including getting, creating, updating, and deleting files.

  • Files(baseUrl, clientId, siteId, fileId?): {
        baseUrl: string;
        clientId: TClientId;
        fileId: string;
        siteId: string;
        get endpoint(): string;
        create(): any;
        delete(): any;
        get(filters?: any): Promise<any>;
        update(): any;
    }

  • Parameters

    • baseUrl: string

      The base URL for the files API.

    • clientId: TClientId

      The clientId parameter is of type TClientId, which is a custom type that represents the client ID. It is used to identify the client associated with the files.

    • siteId: string

      The siteId parameter is a string that represents the ID of a site. It is used to identify a specific site in the system.

    • OptionalfileId: string = null

      The fileId parameter is a string that represents the ID of a specific file. It is optional and can be set to null if no specific file ID is provided.

    Returns {
        baseUrl: string;
        clientId: TClientId;
        fileId: string;
        siteId: string;
        get endpoint(): string;
        create(): any;
        delete(): any;
        get(filters?: any): Promise<any>;
        update(): any;
    }

    The function Files returns an object with the following properties and methods:

Settings

Member Visibility