Options

• roleName : string?

  • Optional

  • Trixta role name

Returns

• isAuthenticated : boolean

  • Will be true if the Trixta space connected with token parameter.

• hasRole : boolean

  • Will be true if the passed roleName for the current user has access.

• hasAccess : boolean

  • Will be true if the hasRole and isAuthenticated mentioned above is true.

• isAuthorizing : boolean

  • Will be true if Trixta is still authorizing the above mentioned roleName

import { useRespondToReactionEffect } from '@trixtateam/trixta-js-core';
const { 
hasRoleAccess,
} = useRespondToReactionEffect<TInitialData>({ 
  roleName:"",
  reactionName:"",
  callBack: (payload?: TInitialData) => {},
  debugMode: false,
   });

Options

• roleName : string

  • Required

  • Trixta role name

• reactionName : string

  • Required

  • Trixta reaction name

• debugMode: boolean

  • Optional

  • Defaults to false.

  • If set to true, enables Trixta console debugging

• callBack : (payload: TInitialData) => void

  • Required

  • This function will fire any time a reaction is received from Trixta.

Returns

• hasRoleAccess : boolean

  • Will be true if the roleName has access for this user.

import { useRespondToReactionResponse } from '@trixtateam/trixta-js-core';
const { 
hasRoleAccess,
latestInstance,
respondToReaction
} = useRespondToReactionResponse<TInitialData>({ 
  roleName:"",
  reactionName:"",
  debugMode: false,
   });

Options

• roleName : string

  • Required

  • Trixta role name

• reactionName : string

  • Required

  • Trixta reaction name

• debugMode: boolean

  • Optional

  • Defaults to false.

  • If set to true, enables Trixta console debugging

Returns

• hasRoleAccess : boolean

  • Will be true if the roleName has access for this user.

• latestInstance : TrixtaReactionInstance

  • First or most recent Trixta instance

• respondToReaction : (parameters: { data, instance, responseEvent, errorEvent }) => void

  • Required

  • This function will respond to the reaction with the data for the given parameters that is received from Trixta.

import { useTrixtaReaction } from '@trixtateam/trixta-js-core';
const { 
hasRoleAccess,
isInProgress,
latestResponse,
loading,
latestInstance,
instances,
initialData,
hasResponse,
submitTrixtaReaction,
clearReactionResponses,
} = useTrixtaReaction<TInitialData,TSuccessType,TErrorType>({ roleName:"",
  reactionName:"",
  requestForEffect:false,
  loadingStatusRef:"",
  debugMode: false,
  setTimeoutEventAsErrorEvent: false,
  clearResponsesOnCallback: false,
  onSuccess:(success)=>{},
  onError:(errror)=>{}
   });

Options

• roleName : string

  • Required

  • Trixta role name

• reactionName : string

  • Required

  • Trixta reaction name

• requestForEffect: boolean

  • Optional

  • Defaults to false.

  • If set to true, this Trixta reaction is not waiting for a response and the only expect to use the initialData

• loadingStatusRef: string

  • Optional

  • Optional value to change the default isInProgress behaviour for when submitting reactions. If you plan to use the same reaction name for the same role, on the same screen, this is when you would make use of this * property

• debugMode: boolean

  • Optional

  • Defaults to false.

  • If set to true, enables Trixta console debugging

• setTimeoutEventAsErrorEvent: boolean

  • Optional

  • Defaults to false.

  • If set to true, will set the timeoutEvent to be the same as the errorEvent

• clearResponsesOnCallback: boolean

  • Optional

  • Defaults to false.

  • If set to true, will clear all responses when onSuccess or onError callbacks are called returning a value true

• onSuccess : (success: TSuccessType) => void|boolean

  • Optional

  • This function will fire any time a successful response is received from Trixta.

  • If you return true and clearResponsesOnCallback is true, all responses will be cleared.

• onError : (error: TErrorType) => void|boolean

  • Optional

  • This function will fire any time an error response is received from Trixta.

  • If you return true and clearResponsesOnCallback is true, all responses will be cleared.

Returns

• hasRoleAccess : boolean

  • Will be true if the roleName has access for this user.

• isInProgress : boolean

  • Will be true if there is no response yet after calling submitTrixtaReactionResponse or submitTrixtaReaction.

  • Will be false if there is a response after calling submitTrixtaReactionResponse or submitTrixtaReaction

• hasResponse : boolean

  • Will be true if there is at least one Trixta Instance response.

• loading : boolean

  • Will be true if the reaction is waiting to be loaded or receive a reaction.

• latestResponse : TrixtaReactionInstanceResponse

  • First or most recent Trixta instance response

• initialData : TInitialData on TrixtaReactionInstance

  • Initial data returned from Trixta reaction instance

• latestInstance : TrixtaReactionInstance

  • First or most recent Trixta instance

• submitTrixtaReaction : (parameters: SubmitTrixtaFunctionParameters) => void

  • This function will submit a response for the given roleName and reactionName

• clearReactionResponses : () => void

  • This function will clear and reset responses for the given roleName and reactionName.

import { useTrixtaAction } from '@trixtateam/trixta-js-core';
const { 
hasRoleAccess,
isInProgress,
hasResponse,
loading,
latestInstance,
response,
submitTrixtaAction,
clearActionResponses,
} = useTrixtaAction<TSuccessType,TErrorType>({ roleName:"",
  actionName:"",
  actionParameters:{
    data:{},
    extraData:{},
    timeout:1500,
    timeoutEvent:"",
    loadingStatusRef:"",
    requestEvent:"",
    responseEvent:"",
    errorEvent:""
  },
  loadingStatusRef:"",
  options: {
    debugMode: false,
    autoSubmit: false,
    setTimeoutEventAsErrorEvent: false,
    clearResponsesOnCallback: false,
  },
  onSuccess:(success)=>{},
  onError:(errror)=>{}
   });

Options

• roleName : string

  • Required

  • Trixta role name

• actionName : string

  • Required

  • Trixta action name

• actionParameters: see related submitTrixtaActionResponse parameters

• loadingStatusRef: string

  • Optional

  • Optional value to change the default isInProgress behaviour for when submitting actions. If you plan to use the same action name for the same role, on the same screen, this is when you would make use of this * property

• options: { debugMode, autoSubmit, setTimeoutEventAsErrorEvent, clearResponsesOnCallback }

  • debugMode: boolean

    • Optional

    • Defaults to false.

    • If set to true, enables Trixta console debugging

  • autoSubmit: boolean

    • Optional

    • Defaults to false.

    • If set to true, hook will submit actionParameters to actionName when the component mounts.

  • setTimeoutEventAsErrorEvent: boolean

    • Optional

    • Defaults to false.

    • If set to true, will set the actionParameters timeoutEvent to be the same as the errorEvent

  • clearResponsesOnCallback: boolean

    • Optional

    • Defaults to false.

    • If set to true, will clear all responses when onSuccess or onError callbacks are called returning a value true.

• onSuccess : (success: TSuccessType) => void|boolean

  • Optional

  • This function will fire any time a successful response is received from Trixta.

  • If you return true and clearResponsesOnCallback is true, all responses will be cleared.

• onError : (error: TErrorType) => void|boolean

  • Optional

  • This function will fire any time an error response is received from Trixta.

  • If you return true and clearResponsesOnCallback is true, all responses will be cleared.

Returns

• hasRoleAccess : boolean

  • Will be true if the roleName has access for this user.

• isInProgress : boolean

  • Will be true if there is no response yet after calling submitTrixtaActionResponse or submitTrixtaAction.

  • Will be false if there is a response after calling submitTrixtaActionResponse or submitTrixtaAction

• hasResponse : boolean

  • Will be true if there is at least one Trixta Instance response.

• loading : boolean

  • Will be true if the action is waiting to be loaded.

• response : TrixtaInstanceResponse

  • First or most recent Trixta instance response

• latestInstance : TrixtaInstance

  • First or most recent Trixta instance

• submitTrixtaAction : (parameters: SubmitTrixtaFunctionParameters) => void

  • This function will submit a request for the given roleName and actionName

• clearActionResponses : () => void

  • This function will clear and reset responses for the given roleName and actionName.

Options

• space : string

  • Required

  • to connect to

• params : Object | unknown

  • Optional

  • Any optional params when you connect to the Trixta space

Returns

This hook returns nothing

Options

• roles : Array<>

  • Required

  • An array of roles with their name and any optional additionalData you wish to pass

Returns

The hook returns nothing.

Options

• roleName : string

  • Trixta role name

Returns

This hook returns nothing

Options

• actionProps: { roleName, actionName }

  • roleName : string

    • Required

    • Trixta role name

  • actionName : string

    • Required

    • Trixta action name

• reactionProps: { roleName, reactionName, requestForEffect }

  • roleName : string?

    • Optional

    • Trixta role name

    • If the roleName for actionProps is the same, this can be excluded

  • reactionName : string

    • Required

    • Trixta reaction name

  • requestForEffect: boolean

    • Optional

    • Defaults to false.

    • If set to true, this Trixta reaction is not waiting for a response and the only expect to use the initialData

• autoSubmit: boolean

  • Optional

  • Defaults to false.

  • If set to true, hook will submit actionParameters to actionName when the component mounts.

Returns

• hasRoleAccess : boolean

  • Will be true if the roleName has access for this user.

• isInProgress : boolean

• hasActionResponse : boolean

• hasReactionResponse : boolean

• • Initial data returned from Trixta reaction instance

• hasResponse : boolean

  • value is based on hasReactionResponse or hasActionResponse .

• loading : boolean

• clearActionResponses : () => void

• clearReactionResponses : () => void

Options

• roleName : string

  • Trixta role name

Returns

• boolean

  • Will be true if the roleName mentioned above has access.