website logo
👥 Community🎯 Samples on GitHub🚦 System Status
💡 Guides
🚀 Examples
🍕 Developer Reference
⚡️ Changelog
🎥 Video Library
Navigate through spaces
⌘K
Overview
Reference
Actions
Data
UI
Widgets
Docs powered by
Archbee
Reference
Actions

ja-open-scanner

25min


Sub Schemas

The schema defines the following additional types:

JAOpenScannerConfig (JAOpenScannerOnButtonConfig | JAOpenScannerInBackgroundConfig)

Use this action to open scanner for scanning different type of data

The object must be any of the following types:

JAOpenScannerConfig (JAOpenScannerOnButtonConfig)

JAOpenScannerConfig (JAOpenScannerInBackgroundConfig)

JAOpenScannerOnButtonConfig (action.open-scanner)

Use this action to open scanner for scanning different type of data

Properties of the JAOpenScannerOnButtonConfig object:

Property

Type

Required

Description

type

action.open-scanner

true



instanceId

InstanceId | Expression

false



when

Expression | boolean

false

When the property is set to 'false', the action will not execute. Default is 'true'.

options

Open Scanner Options

true

Options related to Jig Actions on bottom panel

instanceId (InstanceId | Expression)

when (Expression | boolean)

When the property is set to 'false', the action will not execute. Default is 'true'.

options (Open Scanner Options, required)

Options related to Jig Actions on bottom panel

Properties of the options object:

Property

Type

Required

Description

title

string | Expression | TextWithFormat | TextLocale

true

Title of action displayed on a button.

icon

icon-name | string

false

Icon of action displayed on a button.

style

object

false

More of them can be true. It will be evaluated based on priority.

isHidden

boolean | string

false

Hides the button when `true`

modal

Modal options *

false



onSuccess

keg-action-in-background

false



onFail

keg-action-in-background

false



title (string | Expression | TextWithFormat | TextLocale, required)

Title of action displayed on a button.

icon (icon-name | string)

Icon of action displayed on a button.

The object must be any of the following types:

icon (icon-name)

icon (string)

style (object)

More of them can be true. It will be evaluated based on priority.

isHidden (boolean | string)

Hides the button when true

The object must be any of the following types:

isHidden (string)

modal (Modal options *)

Properties of the modal object:

Property

Type

Required

Description

title

string | Expression | TextWithFormat | TextLocale

false



description

string | Expression | TextWithFormat | TextLocale

false



title (string | Expression | TextWithFormat | TextLocale)

description (string | Expression | TextWithFormat | TextLocale)

onSuccess (keg-action-in-background)

onFail (keg-action-in-background)

JAOpenScannerInBackgroundConfig (action.open-scanner)

Use this action to open scanner for scanning different type of data

Properties of the JAOpenScannerInBackgroundConfig object:

Property

Type

Required

Description

type

action.open-scanner

true



instanceId

InstanceId | Expression

false



when

Expression | boolean

false

When the property is set to 'false', the action will not execute. Default is 'true'.

options

Open Scanner Options

true

Options related to Jig Actions on bottom panel

instanceId (InstanceId | Expression)

when (Expression | boolean)

When the property is set to 'false', the action will not execute. Default is 'true'.

options (Open Scanner Options, required)

Options related to Jig Actions on bottom panel

Properties of the options object:

Property

Type

Required

Description

modal

Modal options *

false



onSuccess

keg-action-in-background

false



onFail

keg-action-in-background

false



modal (Modal options *)

Properties of the modal object:

Property

Type

Required

Description

title

string | Expression | TextWithFormat | TextLocale

false



description

string | Expression | TextWithFormat | TextLocale

false



title (string | Expression | TextWithFormat | TextLocale)

description (string | Expression | TextWithFormat | TextLocale)

onSuccess (keg-action-in-background)

onFail (keg-action-in-background)



Updated 25 Sep 2023
Did this page help you?
PREVIOUS
ja-go-to
NEXT
ja-open-url
Docs powered by
Archbee
TABLE OF CONTENTS
Sub Schemas
JAOpenScannerConfig (JAOpenScannerOnButtonConfig | JAOpenScannerInBackgroundConfig)
JAOpenScannerConfig (JAOpenScannerOnButtonConfig)
JAOpenScannerConfig (JAOpenScannerInBackgroundConfig)
JAOpenScannerOnButtonConfig (action.open-scanner)
instanceId (InstanceId | Expression)
when (Expression | boolean)
options (Open Scanner Options, required)
title (string | Expression | TextWithFormat | TextLocale, required)
icon (icon-name | string)
icon (icon-name)
icon (string)
style (object)
isHidden (boolean | string)
isHidden (string)
modal (Modal options *)
title (string | Expression | TextWithFormat | TextLocale)
description (string | Expression | TextWithFormat | TextLocale)
onSuccess (keg-action-in-background)
onFail (keg-action-in-background)
JAOpenScannerInBackgroundConfig (action.open-scanner)
instanceId (InstanceId | Expression)
when (Expression | boolean)
options (Open Scanner Options, required)
modal (Modal options *)
title (string | Expression | TextWithFormat | TextLocale)
description (string | Expression | TextWithFormat | TextLocale)
onSuccess (keg-action-in-background)
onFail (keg-action-in-background)
Docs powered by
Archbee
Copyright © 2023 Jigx, Inc. All rights reserved. Terms of Service