Module: apollo

Namespaces

• gql

References

useProfile

Re-exports useProfile

---

useProfileEditor

Re-exports useProfileEditor

---

useProfileQuery

Re-exports useProfileQuery

---

useProfileUpdate

Re-exports useProfileUpdate

Type aliases

ApolloClientType

Ƭ ApolloClientType: ApolloClient<object>

Variables

ApolloProvider

• ApolloProvider: React.FC<ApolloProviderProps<any>>

---

DeleteUser

• DeleteUser: DocumentNode

---

useLocalThreads

• useLocalThreads: UseBoundStore<LocalThreadsState, StoreApi<LocalThreadsState>>

deprecated Avoid global state

Functions

UserApolloProvider

▸ UserApolloProvider(__namedParameters): FunctionComponentElement<ApolloProviderProps<any>>

Parameters

Name	Type
__namedParameters	Object
__namedParameters.children	ReactNode

Returns

FunctionComponentElement<ApolloProviderProps<any>>

---

UserApolloProviderWs

▸ UserApolloProviderWs(__namedParameters): FunctionComponentElement<ApolloProviderProps<any>>

Parameters

Name	Type
__namedParameters	Object
__namedParameters.children	ReactNode

Returns

FunctionComponentElement<ApolloProviderProps<any>>

---

gql

▸ gql(literals, ...args): DocumentNode

Parameters

Name	Type
literals	string | readonly string[]
...args	any[]

Returns

DocumentNode

---

insertThread

▸ insertThread(client, uid, thread): Promise<FetchResult<any, Record<string, any>, Record<string, any>>>

Parameters

Name	Type
client	ApolloClientType
uid	string
thread	any

Returns

Promise<FetchResult<any, Record<string, any>, Record<string, any>>>

---

send

▸ send(client, __namedParameters): void

deprecated Manage optimistic send using local state

Parameters

Name	Type
client	ApolloClientType
__namedParameters	SendMessage & { tid: string }

Returns

void

---

updateThread

▸ updateThread(client, variables): void

Parameters

Name	Type
client	any
variables	any

Returns

void

---

useApolloClient

▸ useApolloClient(): ApolloClient<object>

Returns

ApolloClient<object>

---

useFlow

▸ useFlow(flowName): Object

Parameters

Name	Type
flowName	string

Returns

Object

Name	Type
data?	any
error?	ApolloError
loading	boolean
variables	undefined | { flowName: string }

---

useFlowReminders

▸ useFlowReminders(): Object

Returns

Object

Name	Type
create	(reminder: any) => void
loading	boolean
reminders	undefined | UserDocReminder[]
remove	(id: string) => void
update	(id: string, updates: any) => void

---

useMedication

▸ useMedication(): Object

Returns

Object

Name	Type
create	(medication: any) => void
medications	undefined | Medication[]
remove	(id: string) => void
update	(id: string, updates: any) => void

---

useMutation

▸ useMutation<TData, TVariables>(mutation, options?): MutationTuple<TData, TVariables>

Type parameters

Name	Type
TData	any
TVariables	OperationVariables

Parameters

Name	Type
mutation	DocumentNode | TypedDocumentNode<TData, TVariables>
options?	MutationHookOptions<TData, TVariables>

Returns

MutationTuple<TData, TVariables>

---

useQuery

▸ useQuery<TData, TVariables>(query, options?): QueryResult<TData, TVariables>

Type parameters

Name	Type
TData	any
TVariables	OperationVariables

Parameters

Name	Type
query	DocumentNode | TypedDocumentNode<TData, TVariables>
options?	QueryHookOptions<TData, TVariables>

Returns

QueryResult<TData, TVariables>

---

useStartedFlow

▸ useStartedFlow(flowName): Object

Parameters

Name	Type
flowName	string

Returns

Object

Name	Type
data?	any
error?	ApolloError
loading	boolean
variables	undefined | { flowName: string ; status: string = 'flow_started' }

---

useSubscription

▸ useSubscription<TData, TVariables>(subscription, options?): Object

Type parameters

Name	Type
TData	any
TVariables	OperationVariables

Parameters

Name	Type
subscription	DocumentNode | TypedDocumentNode<TData, TVariables>
options?	SubscriptionHookOptions<TData, TVariables>

Returns

Object

Name	Type
data?	TData
error?	ApolloError
loading	boolean
variables	TVariables | undefined

---

useThread2

▸ useThread2(tid): Object

deprecated depends on useLocalThreads

Parameters

Name	Type
tid	string

Returns

Object

Name	Type
data	any
error	undefined | ApolloError
loading	boolean
messages	Message[]