Enumeration DirectorySessionInterfaceSignal

The DirectorySessionInterfaceSignal lists all the signals that may be sent by the DirectorySessionInterface.

These signals are emitted by the DirectorySessionInterface when

• The authentication mechanism has succeeded (LoginSuccess).
• The authentication mechanism has failed (LoginFailed).
• The DirectorySessionInterface has been disconnected (LoggedOff).
• The build list available from the directory has been refreshed (after a call to DirectorySessionInterface.refreshAccessRightsInfo) (AccessRightsRefreshed).
• The build list available from the directory could not be refreshed (after a call to DirectorySessionInterface.refreshAccessRightsInfo) (AccessRightsRefreshFailed).

/** 
 * Sample to illustrate the DirectorySessionInterface signals handling.
 */
import { DirectorySessionInterface, DirectorySessionInterfaceSignal, tListenerCallback, ConnectionData, InfiniteEvent } from 'generated_files/documentation/appinfiniteapi';

// directory session has been created previously
let lDirectorySession : DirectorySessionInterface;
// not relevant at the moment
let onLoginFailed : tListenerCallback;
// not relevant at the moment
let onSignOut : tListenerCallback;
// not relevant at the moment
let onRefreshAccessRightsFailed : tListenerCallback;

// parse the build list and user infos
const onLoginSuccess = (pEvent: InfiniteEvent, _pCallbackData: Object | undefined) : void =>
{
    // Get the Attachment
    const lAttachments: ConnectionData = pEvent.attachments;

    // iterate over project and output project info
    for (const lProjectId in lAttachments.projects) {
        const lProjectInfo = lAttachments.projects[lProjectId];
        console.log('project name : ' + lProjectInfo.projectname + ' project id :' + lProjectInfo.projectid);
        console.log(JSON.stringify(lProjectInfo.builds));
    }
    // output user infos
    console.log('user logged in : ' + lAttachments.user.name);
    console.log('user teams : ' + JSON.stringify(lAttachments.teams));
};

// connect to signals
lDirectorySession.addEventListener(DirectorySessionInterfaceSignal.LoginSuccess, onLoginSuccess);
lDirectorySession.addEventListener(DirectorySessionInterfaceSignal.LoginFailed, onLoginFailed);
lDirectorySession.addEventListener(DirectorySessionInterfaceSignal.LoggedOff, onSignOut);
lDirectorySession.addEventListener(DirectorySessionInterfaceSignal.AccessRightsRefreshed, onLoginSuccess);
lDirectorySession.addEventListener(DirectorySessionInterfaceSignal.AccessRightsRefreshFailed, onRefreshAccessRightsFailed);

Copy

Please refer to DirectorySessionInterface for more information.

See

DirectorySessionInterface