Skip to main content

useUserMetafields

@shopify/shop-minis-platform-sdk / hooks/useUserMetafields

useGetUserMetafield()

useGetUserMetafield(key): object

Parameters

ParameterType
keystring

Returns

object

loading

loading: boolean

refetch()

refetch: (variables?) => Promise\<ApolloQueryResult\<UserMetafieldsQueryData>>

Parameters
ParameterType
variables?Partial\<OperationVariables>
Returns

Promise\<ApolloQueryResult\<UserMetafieldsQueryData>>

value

value: undefined | string


useSetUserMetafield()

useSetUserMetafield(): object

Returns

object

updateUserMetafields()

updateUserMetafields: (options?) => Promise\<FetchResult\<UserMetafieldsSetMutationData>>

Parameters
ParameterType
options?MutationFunctionOptions\<UserMetafieldsSetMutationData, OperationVariables, DefaultContext, ApolloCache\<any>>
Returns

Promise\<FetchResult\<UserMetafieldsSetMutationData>>


useUserMetafields()

useUserMetafields(): object

Returns

object

updateUserMetafieldsInfo()

updateUserMetafieldsInfo: (key, value) => Promise\<FetchResult\<UserMetafieldsSetMutationData>>

Parameters
ParameterType
keystring
valuestring
Returns

Promise\<FetchResult\<UserMetafieldsSetMutationData>>