Class TouchSell

Global proxy object provided by the application

Index

Documents

findDocumentsByName getAllDocuments getCurrentDocument getDocumentById getDocumentByPath

Properties

Accessors

Cart (Sharing)

createCart findCartWithAttribute getCart getCurrentCart setCurrentCart

Collections (NodeList/Presentation/Meeting)

createCollection createNodeList findNodeListInNameSpace findNodeListWithAttribute getAllCollections getCollectionByName getCurrentCollection getNodeListById removeCollection setCurrentCollection

Configuration

getAppId getAppName getClientId getDeviceId getLanguageCode getLanguageName getUserEmail getUserFirstName getUserFullName getUserLastName getUserLogin setAppId setClientId

Contact

createContact getAllContacts getContactByEmail

Document Actions

alert alertWithTitle close getGlobalVar getParams openUrl openUrlExternally presentEmailMessage setGlobalVar

Folders

findFoldersByName getAllFolders getFolderById

Navigation

openCarts openCollections openNotifications openPresentation openSettings

Nodes

findNodesByName findNodesWithKey findNodesWithKeyAndValue findNodesWithTag getAllNodes getAllUserSpaces getCurrentNode getNodeById getNodeByPath

Synchronization

Documents

`Static`findDocumentsByName

findDocumentsByName(name: string): Promise<(TSDocument | null)[]>
Parameters
- name: string
Returns Promise<(TSDocument | null)[]>
the list of documents which name matches “name”.

`Static`getAllDocuments

getAllDocuments(): Promise<(TSDocument | null)[]>
Returns Promise<(TSDocument | null)[]>
the whole list of documents the current user has access to in the app.

`Static`getCurrentDocument

getCurrentDocument(): Promise<TSDocument | null>
Returns Promise<TSDocument | null>
the current document in the Javascript context or NULL if irrelevant.

`Static`getDocumentById

getDocumentById(id: unknown): Promise<TSDocument | null>
Parameters
- id: unknown
  The ID of the document to be retrieved.
Returns Promise<TSDocument | null>
the found document or NULL.

`Static`getDocumentByPath

getDocumentByPath(path: string): Promise<TSDocument | null>
Parameters
- path: string
  The full path to the document to be retrieved, e.g. “path/to/mydocument”.
Returns Promise<TSDocument | null>
the found document or NULL.

Properties

`Static` `Readonly`APIVersion

APIVersion: 1

Returns

1

Accessors

`Static`platform

get platform(): void
Returns void
ios, android, windows or web

Cart (Sharing)

`Static`createCart

createCart(): Promise<TSCart | null>
Returns Promise<TSCart | null>

`Static`findCartWithAttribute

findCartWithAttribute(key: string, value: string): Promise<TSCart | null>
Parameters
- key: string
- value: string
Returns Promise<TSCart | null>

`Static`getCart

getCart(id: string): Promise<TSCart | null>
Parameters
- id: string
Returns Promise<TSCart | null>

`Static`getCurrentCart

getCurrentCart(): Promise<TSCart | null>
Returns Promise<TSCart | null>
the current cart.

`Static`setCurrentCart

setCurrentCart(cart: TSCart): Promise<void>
Parameters
- cart: TSCart
Returns Promise<void>
Deprecated

Collections (NodeList/Presentation/Meeting)

`Static`createCollection

createCollection(
    name: string,
    allContent?: boolean,
    consultation?: boolean,
    plannedAt?: string,
): Promise<TSCollection | undefined>
Parameters
- name: string
- allContent: boolean = false
- consultation: boolean = false
- plannedAt: string = ''
Returns Promise<TSCollection | undefined>

`Static`createNodeList

createNodeList(name: string): Promise<void>
Parameters
- name: string
Returns Promise<void>

`Static`findNodeListInNameSpace

findNodeListInNameSpace(
namespace: string,
): Promise<(TSCollection | undefined)[]>
Parameters
- namespace: string
Returns Promise<(TSCollection | undefined)[]>

`Static`findNodeListWithAttribute

findNodeListWithAttribute(
    key: string,
    value: string,
    namespace: string,
): Promise<(TSCollection | undefined)[]>
Parameters
- key: string
- value: string
- namespace: string
Returns Promise<(TSCollection | undefined)[]>

`Static`getAllCollections

getAllCollections(): Promise<(TSCollection | undefined)[]>
Returns Promise<(TSCollection | undefined)[]>

`Static`getCollectionByName

getCollectionByName(name: string): Promise<TSCollection | undefined>
Parameters
- name: string
Returns Promise<TSCollection | undefined>

`Static`getCurrentCollection

getCurrentCollection(): Promise<TSCollection | undefined>
Returns Promise<TSCollection | undefined>

`Static`getNodeListById

getNodeListById(id: unknown): Promise<any>
Parameters
- id: unknown
Returns Promise<any>

`Static`removeCollection

removeCollection(collection: TSCollection): Promise<void>
Parameters
- collection: TSCollection
Returns Promise<void>

`Static`setCurrentCollection

setCurrentCollection(collection: TSCollection): Promise<void>
Parameters
- collection: TSCollection
Returns Promise<void>

Configuration

`Static`getAppId

getAppId(): Promise<string>
Returns Promise<string>

`Static`getAppName

getAppName(): Promise<string>
Returns Promise<string>

`Static`getClientId

getClientId(): Promise<string>
Returns Promise<string>

`Static`getDeviceId

getDeviceId(): Promise<string>
Returns Promise<string>
the unique identifier for the device.

`Static`getLanguageCode

getLanguageCode(): Promise<string>
Returns Promise<string>

`Static`getLanguageName

getLanguageName(): Promise<string>
Returns Promise<string>

`Static`getUserEmail

getUserEmail(): Promise<string>
Returns Promise<string>

`Static`getUserFirstName

getUserFirstName(): Promise<string>
Returns Promise<string>

`Static`getUserFullName

getUserFullName(): Promise<string>
Returns Promise<string>

`Static`getUserLastName

getUserLastName(): Promise<string>
Returns Promise<string>

`Static`getUserLogin

getUserLogin(): Promise<string>
Returns Promise<string>

`Static`setAppId

setAppId(appId: string): Promise<string>
Parameters
- appId: string
Returns Promise<string>

`Static`setClientId

setClientId(clientId: string): Promise<string>
Parameters
- clientId: string
Returns Promise<string>

Contact

`Static`createContact

createContact(
    email: string,
    firstname?: string,
    lastname?: string,
    phone?: string,
    role?: string,
    company?: string,
): Promise<TSContact | null>
Parameters
- email: string
- firstname: string = ''
- lastname: string = ''
- phone: string = ''
- role: string = ''
- company: string = ''
Returns Promise<TSContact | null>
the new contact created

`Static`getAllContacts

getAllContacts(): Promise<(TSContact | null)[]>
Returns Promise<(TSContact | null)[]>
the whole list of contacts the current user has access to in the app.

`Static`getContactByEmail

getContactByEmail(email: string): Promise<TSContact | null>
Parameters
- email: string
  The Email of the contact to be retrieved
Returns Promise<TSContact | null>
the found contact or undefined

Document Actions

`Static`alert

alert(content: string): Promise<void>
This will open an OS-native popup.
Parameters
- content: string
Returns Promise<void>

`Static`alertWithTitle

alertWithTitle(message: string, title: string): Promise<void>
Parameters
- message: string
- title: string
Returns Promise<void>

`Static`close

close(): Promise<void>
Returns Promise<void>

`Static`getGlobalVar

getGlobalVar(key: string, namespace: string): Promise<string>
Parameters
- key: string
  The key for the global variable.
- namespace: string
  The namespace for the variable. Default value is “script”.
Returns Promise<string>
the value for the key or NULL.

`Static`getParams

getParams(): Promise<Record<string, string>>
Returns Promise<Record<string, string>>
the hash map of all the keys and values for the current Javascript context.

`Static`openUrl

openUrl(url: string): Promise<void>
Load url in the in-app browser, or in another tab on the web.
Parameters
- url: string
Returns Promise<void>

`Static`openUrlExternally

openUrlExternally(url: string): Promise<void>
Load url in the native browser externally, or in another tab on the web.
Parameters
- url: string
Returns Promise<void>

`Static`presentEmailMessage

presentEmailMessage(): Promise<void>
Returns Promise<void>
Deprecated

`Static`setGlobalVar

setGlobalVar(key: string, value: string, namespace: string): Promise<void>
Parameters
- key: string
  The key for the global variable.
- value: string
  The value corresponding to “key”.
- namespace: string
  The namespace for the variable. Default value is “script”.
Returns Promise<void>

Folders

`Static`findFoldersByName

findFoldersByName(name: string): Promise<(TSFolder | null)[]>
Parameters
- name: string
Returns Promise<(TSFolder | null)[]>
the list of folders which name matches “name”.

`Static`getAllFolders

getAllFolders(): Promise<(TSFolder | null)[]>
Returns Promise<(TSFolder | null)[]>
the whole list of folders the current user has access to in the app.

`Static`getFolderById

getFolderById(id: unknown): Promise<TSFolder | null>
Parameters
- id: unknown
  The ID of the document to be retrieved.
Returns Promise<TSFolder | null>
the found document or NULL.

Navigation

`Static`openCarts

openCarts(): Promise<void>
Returns Promise<void>

`Static`openCollections

openCollections(): Promise<void>
Returns Promise<void>

`Static`openNotifications

openNotifications(): Promise<void>
Returns Promise<void>

`Static`openPresentation

openPresentation(): Promise<void>
Returns Promise<void>

`Static`openSettings

openSettings(): Promise<void>
Returns Promise<void>

Nodes

`Static`findNodesByName

findNodesByName(name: string): Promise<(TSNode | null)[]>
Parameters
- name: string
Returns Promise<(TSNode | null)[]>
the list of nodes which name matches “name”.

`Static`findNodesWithKey

findNodesWithKey(key: string, namespace: string): Promise<(TSNode | null)[]>
Parameters
- key: string
- namespace: string
Returns Promise<(TSNode | null)[]>

`Static`findNodesWithKeyAndValue

findNodesWithKeyAndValue(
    key: string,
    value: string,
    namespace: string,
): Promise<(TSNode | null)[]>
Parameters
- key: string
- value: string
- namespace: string
Returns Promise<(TSNode | null)[]>

`Static`findNodesWithTag

findNodesWithTag(tag: string): Promise<(TSNode | null)[]>
Parameters
- tag: string
Returns Promise<(TSNode | null)[]>

`Static`getAllNodes

getAllNodes(): Promise<(TSNode | null)[]>
Returns Promise<(TSNode | null)[]>
the whole list of nodes the current user has access to in the app.

`Static`getAllUserSpaces

getAllUserSpaces(): Promise<(TSNode | null)[]>
Returns Promise<(TSNode | null)[]>

`Static`getCurrentNode

getCurrentNode(): Promise<TSNode | null>
Returns Promise<TSNode | null>
the current node in the Javascript context.

`Static`getNodeById

getNodeById(id: unknown): Promise<TSNode | null>
Parameters
- id: unknown
  The ID of the node to be retrieved
Returns Promise<TSNode | null>
the found node or undefined

`Static`getNodeByPath

getNodeByPath(path: string): Promise<TSNode | null>
Parameters
- path: string
  The full path to the node to be retrieved, e.g. “path/to/mynode”.
Returns Promise<TSNode | null>
the found node or undefined.

Synchronization

`Static`push

push(): Promise<void>
Use “push” to push all waiting data to the back-office (user statistics, carts, filled forms...)

Returns Promise<void>