Module: hooks/useSCFetchBroadcastMessages
Functions
useSCFetchBroadcastMessages
▸ useSCFetchBroadcastMessages(props?
): Object
info
This custom hook is used to fetch broadcast messages.
Parameters
Name | Type |
---|---|
props? | Object |
props.cacheStrategy? | CacheStrategies |
Returns
Object
Name | Type |
---|---|
data | SCPaginatedResponse <SCBroadcastMessageType > |
fetchMessages | (refresh : boolean ) => Promise <SCPaginatedResponse <SCBroadcastMessageType >> |
loading | boolean |
setMessages | (messages : SCBroadcastMessageType []) => { count : number ; next : string = data.next; previous : string = data.previous; results : SCBroadcastMessageType [] } |
Defined in
packages/react-core/src/hooks/useSCFetchBroadcastMessages.ts:36