Actions

findReplayActions

Returns a list of replay actions.

Web

Implementation.

import { findReplayActions } from '@picsart/web-replay-sdk/actions';

function findReplayActions(replay: IReplay, actionIds?: IReplayAction['id'][]): IReplayAction[]

Android

Implementation.

import com.picsart.media.actions.ActionMeta.Source

IOS

Implementation.

Parameters	Type	Required	Description
replay	IReplay	yes	The replay memory object.
actionIds	IReplayAction['id'][]	no	Ids for actions to find. If missed this will return full list of actions

Returns a IReplayAction[]

addActionToReplay

Web

Implementation.

import { addActionToReplay } from '@picsart/web-replay-sdk/actions';

function addActionToReplay(replay: IReplay, actionParams: Omit<IReplayAction, 'id'>): IReplay

Android

Implementation.

import com.picsart.media.actions.ActionMeta.Source

IOS

Implementation.

Parameters	Type	Required	Description
replay	IReplay	yes	The replay memory object.
actionParams	Omit<IReplayAction>	yes	Action information to be added to replay. The method will also validate the structure validity

Returns a IReplay

removeLastReplayAction

Removes the last done action

Web

Implementation.

import { removeLastReplayAction } from '@picsart/web-replay-sdk/actions';

function removeLastReplayAction(replay: IReplay): IReplay

Android

Implementation.

import com.picsart.media.actions.ActionMeta.Source

IOS

Implementation.

Parameters	Type	Required	Description
replay	IReplay	yes	The replay memory object.

Returns a IReplay

rebuildReplayContext

Recreated the replay context from scratch based on replay actions

Web

Implementation.

import { rebuildReplayContext } from '@picsart/web-replay-sdk/actions';

function rebuildReplayContext(replay: IReplay): IReplayContext

Android

Implementation.

import com.picsart.media.actions.ActionMeta.Source

IOS

Implementation.

Parameters	Type	Required	Description
replay	IReplay	yes	The replay memory object.

Returns a IReplayContext

addInitActionToReplay

Replay always starts with action. This action is able to start a replay for an empty state or for already existing state.

Web

Implementation.

import { addInitActionToReplay } from '@picsart/web-replay-sdk/actions';

function addInitActionToReplay(
  replay: IReplay,
  params: {
    init?: {
      layout: IReplayLayout;
      canvasGroupMeta: IReplayLayer['meta'];
      projectGroupMeta: IReplayLayer['meta'];
    };
    context?: IReplayContext;
  },
): IReplay 

Android

Implementation.

import com.picsart.media.actions.ActionMeta.Source

IOS

Implementation.

Parameters	Type	Required	Description
replay	IReplay	yes	The replay memory object.
params	{ init?: { layout: IReplayLayout; canvasGroupMeta: IReplayLayer['meta']; projectGroupMeta: IReplayLayer['meta']; }; context?: IReplayContext; }	yes	Either init or context must be passed. Use init if you're just starting an editing. If you are migrating editing state from a different version it's better to use context

Returns a IReplay