Forest Admin - API reference
    Preparing search index...

    Function createRemoteAgentClient

    • Parameters

      • params: {
            actionEndpoints?: ActionEndpointsByCollection;
            forestServer?: {
                renderingId: string | number;
                serverToken: string;
                serverUrl: string;
            };
            overridePermissions?: (permissions: PermissionsOverride) => Promise<void>;
            token?: string;
            url: string;
        }
        • OptionalactionEndpoints?: ActionEndpointsByCollection
        • OptionalforestServer?: { renderingId: string | number; serverToken: string; serverUrl: string }

          Connection to the Forest Admin server. Provide it to enable server-side features that call the Forest server (e.g. creating approval requests); omit it for a client that only talks to the agent (e.g. tests). serverUrl is the Forest server, distinct from the agent url above.

        • OptionaloverridePermissions?: (permissions: PermissionsOverride) => Promise<void>
        • Optionaltoken?: string
        • url: string

      Returns RemoteAgentClient<Record<string, unknown>>