ic-reactor
    Preparing search index...

    Interface UseSharedCallParameters<A, M>

    Configuration to make calls to the Replica.

    interface UseSharedCallParameters<A, M extends types.FunctionName<A>> {
        agent?: utils.agent.Agent;
        pollingOptions?: utils.agent.PollingOptions;
        canisterId?: string | types.Principal;
        effectiveCanisterId?: types.Principal;
        nonce?: Uint8Array<ArrayBufferLike>;
        functionName: M;
        args?: types.ActorMethodParameters<A[M]>;
        onLoading?: (loading: boolean) => void;
        onError?: (error: undefined | utils.agent.AgentError) => void;
        onSuccess?: (data: types.ActorMethodReturnType<A[M]>) => void;
        onSuccessResult?: (
            value: types.ExtractOk<types.ActorMethodReturnType<A[M]>>,
        ) => void;
        onErrorResult?: (
            error: types.ExtractErr<types.ActorMethodReturnType<A[M]>>,
        ) => void;
        throwOnError?: boolean;
    }

    Type Parameters

    Hierarchy (View Summary)

    Index

    Properties

    agent? pollingOptions? canisterId? effectiveCanisterId? nonce? functionName args? onLoading? onError? onSuccess? onSuccessResult? onErrorResult? throwOnError?

    Properties

    agent?: utils.agent.Agent

    An agent to use in this call, otherwise the actor or call will try to discover the agent to use.

    pollingOptions?: utils.agent.PollingOptions

    Options for controlling polling behavior.

    canisterId?: string | types.Principal

    The canister ID of this Actor.

    effectiveCanisterId?: types.Principal

    The effective canister ID. This should almost always be ignored.

    nonce?: Uint8Array<ArrayBufferLike>

    The nonce to use for this call. This is used to prevent replay attacks.

    functionName: M
    args?: types.ActorMethodParameters<A[M]>
    onLoading?: (loading: boolean) => void
    onError?: (error: undefined | utils.agent.AgentError) => void
    onSuccess?: (data: types.ActorMethodReturnType<A[M]>) => void
    onSuccessResult?: (
        value: types.ExtractOk<types.ActorMethodReturnType<A[M]>>,
    ) => void
    onErrorResult?: (
        error: types.ExtractErr<types.ActorMethodReturnType<A[M]>>,
    ) => void
    throwOnError?: boolean

    Settings

    Member Visibility

    On This Page

    Properties