Reactions - Reaction service client
The ReactionServiceClient class is another key element used in the Reactions memory state management. It wraps all API calls to the pf-reactions-service required for communicating with the remote API.
Usage
import { MemoryReactionsStore, State, ReactionServiceClient } from '@atlaskit/reactions';
const apiConfig = {
baseUrl: 'http://www.example.org',
// optional, generate token from asap, check \`pf-emoji-service\` for more info
authHeader: 'Bearer token',
};
// Create a client object fetching the reactions data from the specified url
const client = new ReactionServiceClient(apiConfig.baseUrl, apiConfig.authHeader) = {};
// Add the client to the MemoryReactionsStore class
// Define the initial state object
const intialState: State = {
reactions: {},
flash: {}
};
// Define the store object that will handle all the reactions data (get/set/remove) and the API calls to the server
const store = new MemoryReactionsStore(client, intialState, {
subproduct: 'atlaskit',
});ReactionClient type
getReactions function required
fetch reactions request handler @param containerAri container wrapper id @param aris container reaction assets unique ids
function containerAri, aris => PromiseRecordstring, Arrayari string required containerAri string required emojiId string required count number required reacted boolean required users arrayType Arrayid string required displayName string required profilePicture path string required accountId string optimisticallyUpdated boolean getDetailedReaction (ari, containerAri, emojiId, metadata) => Promise<T><object> required
Fetch details for a given reaction.
(ari, containerAri, emojiId, metadata) => Promise<T>ari string required containerAri string required emojiId string required count number required reacted boolean required users arrayType Arrayid string required displayName string required profilePicture path string required accountId string optimisticallyUpdated boolean addReaction (ari, containerAri, emojiId, metadata) => Promise<T><arrayType> required
Fetch request when adding a reaction to a container.
(ari, containerAri, emojiId, metadata) => Promise<T>Arrayari string required containerAri string required emojiId string required count number required reacted boolean required users arrayType Arrayid string required displayName string required profilePicture path string required accountId string optimisticallyUpdated boolean deleteReaction (ari, containerAri, emojiId, metadata) => Promise<T><arrayType> required
Fetch request when removing a reaction from a container.
(ari, containerAri, emojiId, metadata) => Promise<T>Arrayari string required containerAri string required emojiId string required count number required reacted boolean required users arrayType Arrayid string required displayName string required profilePicture path string required accountId string optimisticallyUpdated boolean