Skip to content

GSD-RestApi Module events

Bonjour/Zeroconf available modules broadcast

Each module can provide broadcast information. It is necessary to add an event macro to your module:

1
2
3
INT xRestApi_GetModulesForBroadcast( 
        DBSTRINGSET &modules 
)

Add the name of your module to the 'modules' DBSTRINGSET.

Caution

Do not clear the 'modules' set, it could prevent broadcasting of other modules names.

External user login - automatic DOCUframe user selection

When a new external user is logging in via OAuth an event macro is called. It allows to assign a DOCUframe user based on:

  • name
  • surname
  • email
  • user uuid be OAuth provider
  • OAuth provider
1
2
3
4
5
6
7
8
INT xRestApi_DBCreateInit_xRestApiUserProvider( 
        xRestApiUserProvider userObject, 
        xRestApiProviderConfig providerConfig, 
        STRING userUuid, 
        STRING name,
        STRING surname, 
        STRING email 
)

Caution

The 'userObject' object shouldn't be locked and stored in the event. Simply assign the selected DOCUframe user to 'userObject.xRestApiDfUser'