• Preparing search index...
  • The search index is not available
@shopify/cli-kit
  • @shopify/cli-kit
  • node/api/app-management
  • appManagementRequestDoc

Function appManagementRequestDoc

  • appManagementRequestDoc<TResult, TVariables extends Variables>(
        orgId: string,
        query: TypedDocumentNode<TResult, TVariables>,
        token: string,
        variables?: TVariables,
        cacheOptions?: CacheOptions,
        requestOptions?: RequestOptions,
        unauthorizedHandler?: UnauthorizedHandler,
    ): Promise<TResult>
  • Executes an org-scoped GraphQL query against the App Management API. Uses typed documents.

    Type Parameters

    • TResult
    • TVariables extends Variables

    Parameters

    • orgId: string

      The organization ID.

    • query: TypedDocumentNode<TResult, TVariables>

      GraphQL query to execute.

    • token: string

      Partners token.

    • Optionalvariables: TVariables

      GraphQL variables to pass to the query.

    • OptionalcacheOptions: CacheOptions

      Cache options for the request. If not present, the request will not be cached.

    • OptionalrequestOptions: RequestOptions

      Preferred behaviour for the request.

    • OptionalunauthorizedHandler: UnauthorizedHandler

      Optional handler for unauthorized requests.

    Returns Promise<TResult>

    The response of the query of generic type .

    • Defined in packages/cli-kit/src/public/node/api/app-management.ts:64

Settings

Member Visibility
@shopify/cli-kit
  • Loading...

Generated using TypeDoc