Reference13r1:PBX/Objects/App: Difference between revisions

From innovaphone wiki
Jump to navigation Jump to search
mNo edit summary
No edit summary
Line 1: Line 1:
<internal>
The App object is used to create a reference to an innovaphone App that can be used in myApps.
::text kopiert von 12r2, müsste geprüft werden für 13r1 - ~~~
App objects can also be used for accepting incoming app websocket connections to the PBX with the configured credentials.
The App object is used to open any URL by use of the PBX client.


* create App object by any ''Long name''/''Name''
; URL: An HTTP(S) URL pointing to the htm file of the app.
* URL: any valid URL point to an application
; Licenses:
* Inline: open URL in myPBX. If not ticked extra window is opened.
; Plain Website: Should be checked if the URL points to a website that is not an innovaphone App. myApps won't do app-specific communication with the iframe then.
* in the App tab of the ''User'' or ''ConfigurationTemplate'' object the name of the app-object is shown as license. Tick to grant for user
; Hidden: If checked, the App should not be shown to the user inside myApps. This is useful when the app just provides APIs for other apps but no user interface.
* within myPBX, the app has to be made visible via app administration page
; Websocket: If checked, the PBX establishes a websocket connection to the app service. On this websocket connection the app can use PBX APIs or publish information that is needed by other apps.
* Icon displayed in myPBX has to be present in main directory location URL is pointing to
; Local presence: If checked, the object should not forward presence subscriptions to the app service on an existing websocket connection. Instead the object stores a presence locally like a regular user object.
</internal>
 
Note that each app needs specific settings depending on the needed or provided features. See the app documentation to find out what checkmarks should be set.

Revision as of 16:58, 19 September 2019

The App object is used to create a reference to an innovaphone App that can be used in myApps. App objects can also be used for accepting incoming app websocket connections to the PBX with the configured credentials.

URL
An HTTP(S) URL pointing to the htm file of the app.
Licenses
Plain Website
Should be checked if the URL points to a website that is not an innovaphone App. myApps won't do app-specific communication with the iframe then.
Hidden
If checked, the App should not be shown to the user inside myApps. This is useful when the app just provides APIs for other apps but no user interface.
Websocket
If checked, the PBX establishes a websocket connection to the app service. On this websocket connection the app can use PBX APIs or publish information that is needed by other apps.
Local presence
If checked, the object should not forward presence subscriptions to the app service on an existing websocket connection. Instead the object stores a presence locally like a regular user object.

Note that each app needs specific settings depending on the needed or provided features. See the app documentation to find out what checkmarks should be set.