1 of 14

Methods

Here you can find information all the react methods that you can dispatch.

Please note all methods need to be dispatched to the redux store either using the

useDispatch hook, the dispatch store function or the put effect in a Saga

Reactions

Trixta reaction related methods can be found here.

submitTrixtaReactionResponse

This method will attempt to respond to a Trixta Reaction for the given roleName and reactionName

import {
  submitTrixtaReactionResponse
} from '@trixtateam/trixta-js-core';

Please note your reaction must be a request for response to use this method.

Parameters

Parameter

Description

Type

roleName

Trixta role name

string

reactionName

Trixta reaction name

string

ref

Unique Trixta reaction reference. Can be found on a

string

responseEvent

Redux event for data to dispatch response to

string?

requestEvent

Redux event for data to dispatch to before submitting request to Trixta

string?

timeoutEvent

Redux event for data to dispatch error response due to timeout

string?

errorEvent

Redux event for data to dispatch error response to

string?

loadingStatusRef

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

string?

timeout

timeout in milliseconds for submitting data to Trixta, default is 15000

number?

extraData

Extra data to pass on and receive in response with the key extraData. This can be used as needed.

any

clearTrixtaReactionResponse

This method will attempt to clear a responses in the Trixta Reducer for the given roleName and reactionName

import {
  clearTrixtaReactionResponse
} from '@trixtateam/trixta-js-core';

Parameters

Parameter

Description

Type

roleName

Trixta role name

string

reactionName

Trixta reaction name

string

loadingStatusRef

see

string?

clearTrixtaReactionRequestStatus

This method will attempt to reset the progress status in the Trixta Reducer for the given roleName and reactionName

import {
  clearTrixtaReactionRequestStatus
} from '@trixtateam/trixta-js-core';

Parameters

Parameter

Description

Type

roleName

Trixta role name

string

reactionName

Trixta reaction name

string

loadingStatusRef

see

string?

Actions

Trixta action related methods can be found here.

submitTrixtaActionResponse

This method will attempt to send a request to the given roleName and actionName

import {
  submitTrixtaActionResponse
} from '@trixtateam/trixta-js-core';

Parameters

Parameter

Description

Type

roleName

Trixta role name

string

actionName

Trixta action name

string

actionOptions

Options for action in Trixta flow

any

debugOptions

Trixta flow debugging options

debugMode

Enables debugging for action in Trixta flow. False by default

boolean?

responseEvent

Redux event for data to dispatch response to

string?

requestEvent

Redux event for data to dispatch to before submitting request to Trixta

string?

timeoutEvent

Redux event for data to dispatch error response due to timeout

string?

errorEvent

Redux event for data to dispatch error response to

string?

loadingStatusRef

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

string?

timeout

timeout in milliseconds for submitting data to Trixta, default is 15000

number?

extraData

Extra data to pass on and receive in response with the key extraData. This can be used as needed.

any

clearResponse

Determines if the instances for action should be cleared before submitting. False by default

boolean?

formData

Data to submit to Trixta

any

clearTrixtaActionResponse

This method will attempt to clear a responses in the Trixta Reducer for the given roleName and actionName

import {
  clearTrixtaActionResponse
} from '@trixtateam/trixta-js-core';

Parameters

Parameter

Description

Type

roleName

Trixta role name

string

actionName

Trixta action name

string

loadingStatusRef

see

string

clearTrixtaActionRequestStatus

This method will attempt reset the progress status in the Trixta Reducer for the given roleName and actionName

import {
  clearTrixtaActionRequestStatus
} from '@trixtateam/trixta-js-core';

Parameters

Parameter

Description

Type

roleName

Trixta role name

string

actionName

Trixta action name

string

loadingStatusRef

see

string

updateTrixtaRole

This method will attempt to join the given Trixta Role on connected Trixta Space

import {
  updateTrixtaRole
} from '@trixtateam/trixta-js-core';

Parameters

Parameter

Description

Type

name

Trixta role name

string

logPresence

determines if phoenix channel presence for role should be logged

boolean

additionalData

Any additional data to pass on joining a role

any

updateTrixtaRoles

This method will attempt to join the given Trixta Roles on connected Trixta Space

import {
  updateTrixtaRoles
} from '@trixtateam/trixta-js-core';

Parameters

Parameter

Description

Type

roles

Array of Trixta roles to join

Array<>

removeTrixtaRole

This method will attempt to leave the given Trixta Role on connected Trixta Space

Parameters

Parameter

Description

Type

connectTrixta

This method will attempt to connect to the passed Trixta space and optional params

Parameters

Parameter

Description

Type

signoutTrixta

This method will attempt to initialize all Trixta State in the reducer

Parameters

None

submitTrixtaActionResponse

This method will attempt to send a request to the given roleName and actionName

import {
  submitTrixtaActionResponse
} from '@trixtateam/trixta-js-core';

Parameters

Parameter

Description

Type

roleName

Trixta role name

string

actionName

Trixta action name

string

actionOptions

Options for action in Trixta flow

any

debugOptions

Trixta flow debugging options

debugMode

Enables debugging for action in Trixta flow. False by default

boolean?

responseEvent

Redux event for data to dispatch response to

string?

requestEvent

Redux event for data to dispatch to before submitting request to Trixta

string?

timeoutEvent

Redux event for data to dispatch error response due to timeout

string?

errorEvent

Redux event for data to dispatch error response to

string?

loadingStatusRef

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

string?

timeout

timeout in milliseconds for submitting data to Trixta, default is 15000

number?

extraData

Extra data to pass on and receive in response with the key extraData. This can be used as needed.

any

clearResponse

Determines if the instances for action should be cleared before submitting. False by default

boolean?

formData

Data to submit to Trixta

any

submitTrixtaReactionResponse

This method will attempt to respond to a Trixta Reaction for the given roleName and reactionName

import {
  submitTrixtaReactionResponse
} from '@trixtateam/trixta-js-core';

Please note your reaction must be a request for response to use this method.

Parameters

Parameter

Description

Type

roleName

Trixta role name

string

reactionName

Trixta reaction name

string

ref

Unique Trixta reaction reference. Can be found on a

string

responseEvent

Redux event for data to dispatch response to

string?

requestEvent

Redux event for data to dispatch to before submitting request to Trixta

string?

timeoutEvent

Redux event for data to dispatch error response due to timeout

string?

errorEvent

Redux event for data to dispatch error response to

string?

loadingStatusRef

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

string?

timeout

timeout in milliseconds for submitting data to Trixta, default is 15000

number?

extraData

Extra data to pass on and receive in response with the key extraData. This can be used as needed.

any