Interface: AppDetails
Represents the details of the app.
Properties
accessedUrls
• Optional accessedUrls: RegExp[]
Only urls which are whitelisted in this array can be accessed through the SodaSync.http object.
Defined in
src/sdk/app-details.ts:64
author
• author: Object
The author of the app. This can be an individual person or a company.
Type declaration
| Name | Type |
|---|---|
email? | string |
name? | string |
Defined in
src/sdk/app-details.ts:35
configuration
• Optional configuration: AppConfiguration
User configuration.
Defined in
src/sdk/app-details.ts:69
description
• description: string
The description about what the app is used for.
Defined in
src/sdk/app-details.ts:30
docs
• Optional docs: AppDocs
Documentation for the app.
Defined in
src/sdk/app-details.ts:59
factory
• factory: AppFactory
The factory to produce the app instance.
If the feature is undefined, the runtime will call checkConfiguration in the Integration interface.
Defined in
src/sdk/app-details.ts:54
featurePairDetector
• Optional featurePairDetector: FeaturePairDetector
A feature detector to help SodaSync detect the feature pair of an incoming web request. You only need to add this, if you process incoming requests and the source system does not support multiple trigger urls.
Defined in
src/sdk/app-details.ts:76
name
• name: string
The name of the app. This will be displayed to all users.
Defined in
src/sdk/app-details.ts:18
oauth2Client
• Optional oauth2Client: OAuth2Client
If you need to authenticate using OAuth 2 that uses redirection, you can provide an OAuth2Client.
Defined in
src/sdk/app-details.ts:81
packageId
• packageId: string
The package id of the app. It consists of tree parts separated by dots and must be a reversed host name. For example: com.sodasync.example-package
Defined in
src/sdk/app-details.ts:25
sdkVersion
• sdkVersion: `${number}.${number}.${number}` | `${number}.${number}.${number}-${string}.${number}`
Defined in
src/sdk/app-details.ts:13
supportedFeatures
• supportedFeatures: keyof AppFeatureMapping[]
The features that are supported by this app.
Defined in
src/sdk/app-details.ts:45
version
• version: `${number}.${number}.${number}`
The semantic version of the app.
Defined in
src/sdk/app-details.ts:40