mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-05-12 17:04:57 +00:00
AAE-29442 moving to node 20.18.1 (#10500)
* AAE-0000 - moving to node 20.18.1 * AAE-29442 Adjusted to the new eslint rule
This commit is contained in:
parent
dd44e492b7
commit
872fb16b62
@ -10,7 +10,7 @@
|
|||||||
"createDefaultProgram": true
|
"createDefaultProgram": true
|
||||||
},
|
},
|
||||||
"rules": {
|
"rules": {
|
||||||
"jsdoc/newline-after-description": "warn",
|
"jsdoc/tag-lines": ["error", "any", {"startLines": 1}],
|
||||||
"@typescript-eslint/naming-convention": "warn",
|
"@typescript-eslint/naming-convention": "warn",
|
||||||
"@typescript-eslint/consistent-type-assertions": "warn",
|
"@typescript-eslint/consistent-type-assertions": "warn",
|
||||||
"@typescript-eslint/prefer-for-of": "warn",
|
"@typescript-eslint/prefer-for-of": "warn",
|
||||||
|
@ -95,7 +95,6 @@ export class CheckAllowableOperationDirective implements OnChanges {
|
|||||||
/**
|
/**
|
||||||
* Enables decorated element
|
* Enables decorated element
|
||||||
*
|
*
|
||||||
* @memberof CheckAllowableOperationDirective
|
|
||||||
*/
|
*/
|
||||||
enableElement(): void {
|
enableElement(): void {
|
||||||
this.renderer.removeAttribute(this.elementRef.nativeElement, 'disabled');
|
this.renderer.removeAttribute(this.elementRef.nativeElement, 'disabled');
|
||||||
@ -104,7 +103,6 @@ export class CheckAllowableOperationDirective implements OnChanges {
|
|||||||
/**
|
/**
|
||||||
* Disables decorated element
|
* Disables decorated element
|
||||||
*
|
*
|
||||||
* @memberof CheckAllowableOperationDirective
|
|
||||||
*/
|
*/
|
||||||
disableElement(): void {
|
disableElement(): void {
|
||||||
this.renderer.setAttribute(this.elementRef.nativeElement, 'disabled', 'true');
|
this.renderer.setAttribute(this.elementRef.nativeElement, 'disabled', 'true');
|
||||||
|
@ -10,7 +10,7 @@
|
|||||||
"createDefaultProgram": true
|
"createDefaultProgram": true
|
||||||
},
|
},
|
||||||
"rules": {
|
"rules": {
|
||||||
"jsdoc/newline-after-description": "warn",
|
"jsdoc/tag-lines": ["error", "any", {"startLines": 1}],
|
||||||
"@typescript-eslint/naming-convention": "off",
|
"@typescript-eslint/naming-convention": "off",
|
||||||
"@typescript-eslint/consistent-type-assertions": "warn",
|
"@typescript-eslint/consistent-type-assertions": "warn",
|
||||||
"@typescript-eslint/prefer-for-of": "off",
|
"@typescript-eslint/prefer-for-of": "off",
|
||||||
|
@ -25,7 +25,6 @@ export class DebugAppConfigService extends AppConfigService {
|
|||||||
super();
|
super();
|
||||||
}
|
}
|
||||||
|
|
||||||
/** @override */
|
|
||||||
get<T>(key: string, defaultValue?: T): T {
|
get<T>(key: string, defaultValue?: T): T {
|
||||||
if (key === AppConfigValues.OAUTHCONFIG) {
|
if (key === AppConfigValues.OAUTHCONFIG) {
|
||||||
return JSON.parse(this.storage.getItem(key)) || super.get<T>(key, defaultValue);
|
return JSON.parse(this.storage.getItem(key)) || super.get<T>(key, defaultValue);
|
||||||
|
@ -254,6 +254,8 @@ export class BasicAlfrescoAuthService extends BaseAuthenticationService {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* logout Alfresco API
|
* logout Alfresco API
|
||||||
|
*
|
||||||
|
* @returns A promise that returns {logout} if resolved and {error} if rejected.
|
||||||
*/
|
*/
|
||||||
async logout(): Promise<any> {
|
async logout(): Promise<any> {
|
||||||
if (this.isBPMProvider()) {
|
if (this.isBPMProvider()) {
|
||||||
|
@ -22,57 +22,53 @@ import { Observable } from 'rxjs';
|
|||||||
* Provide authentication/authorization through OAuth2/OIDC protocol.
|
* Provide authentication/authorization through OAuth2/OIDC protocol.
|
||||||
*/
|
*/
|
||||||
export abstract class AuthService {
|
export abstract class AuthService {
|
||||||
abstract onLogin: Observable<any>;
|
abstract onLogin: Observable<any>;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* An observable that emits a value when a logout event occurs.
|
* An observable that emits a value when a logout event occurs.
|
||||||
* Implement this observable to handle any necessary cleanup or state updates
|
* Implement this observable to handle any necessary cleanup or state updates
|
||||||
* when a user logs out of the application.
|
* when a user logs out of the application.
|
||||||
*
|
*/
|
||||||
* @type {Observable<void>}
|
abstract onLogout$: Observable<void>;
|
||||||
*/
|
|
||||||
abstract onLogout$: Observable<void>;
|
|
||||||
|
|
||||||
abstract onTokenReceived: Observable<any>;
|
abstract onTokenReceived: Observable<any>;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* An abstract observable that emits a boolean value indicating whether the discovery document
|
* An abstract observable that emits a boolean value indicating whether the discovery document
|
||||||
* has been successfully loaded.
|
* has been successfully loaded.
|
||||||
*
|
*/
|
||||||
* @type {Observable<boolean>}
|
abstract isDiscoveryDocumentLoaded$: Observable<boolean>;
|
||||||
*/
|
|
||||||
abstract isDiscoveryDocumentLoaded$: Observable<boolean>;
|
|
||||||
|
|
||||||
/** Subscribe to whether the user has valid Id/Access tokens. */
|
/** Subscribe to whether the user has valid Id/Access tokens. */
|
||||||
abstract authenticated$: Observable<boolean>;
|
abstract authenticated$: Observable<boolean>;
|
||||||
|
|
||||||
/** Get whether the user has valid Id/Access tokens. */
|
/** Get whether the user has valid Id/Access tokens. */
|
||||||
abstract authenticated: boolean;
|
abstract authenticated: boolean;
|
||||||
|
|
||||||
/** Subscribe to errors reaching the IdP. */
|
/** Subscribe to errors reaching the IdP. */
|
||||||
abstract idpUnreachable$: Observable<Error>;
|
abstract idpUnreachable$: Observable<Error>;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Initiate the IdP login flow.
|
* Initiate the IdP login flow.
|
||||||
*/
|
*/
|
||||||
abstract login(currentUrl?: string): Promise<void> | void;
|
abstract login(currentUrl?: string): Promise<void> | void;
|
||||||
|
|
||||||
abstract baseAuthLogin(username: string, password: string): Observable<TokenResponse> ;
|
abstract baseAuthLogin(username: string, password: string): Observable<TokenResponse>;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Disconnect from IdP.
|
* Disconnect from IdP.
|
||||||
*
|
*
|
||||||
* @returns Promise may be returned depending on implementation
|
* @returns Promise may be returned depending on implementation
|
||||||
*/
|
*/
|
||||||
abstract logout(): Promise<void> | void;
|
abstract logout(): Promise<void> | void;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Complete the login flow.
|
* Complete the login flow.
|
||||||
*
|
*
|
||||||
* In browsers, checks URL for auth and stored state. Call this once the application returns from IdP.
|
* In browsers, checks URL for auth and stored state. Call this once the application returns from IdP.
|
||||||
*
|
*
|
||||||
* @returns Promise, resolve with stored state, reject if unable to reach IdP
|
* @returns Promise, resolve with stored state, reject if unable to reach IdP
|
||||||
*/
|
*/
|
||||||
abstract loginCallback(loginOptions?: LoginOptions): Promise<string | undefined>;
|
abstract loginCallback(loginOptions?: LoginOptions): Promise<string | undefined>;
|
||||||
abstract updateIDPConfiguration(...args: any[]): void;
|
abstract updateIDPConfiguration(...args: any[]): void;
|
||||||
}
|
}
|
||||||
|
@ -51,8 +51,6 @@ export class OidcAuthenticationService extends BaseAuthenticationService {
|
|||||||
* This observable combines the authentication status and the discovery document load status
|
* This observable combines the authentication status and the discovery document load status
|
||||||
* to decide if an SSO login is necessary. It emits `true` if the user is not authenticated
|
* to decide if an SSO login is necessary. It emits `true` if the user is not authenticated
|
||||||
* and the discovery document is loaded, otherwise it emits `false`.
|
* and the discovery document is loaded, otherwise it emits `false`.
|
||||||
*
|
|
||||||
* @type {Observable<boolean>}
|
|
||||||
*/
|
*/
|
||||||
shouldPerformSsoLogin$: Observable<boolean> = combineLatest([this.auth.authenticated$, this.auth.isDiscoveryDocumentLoaded$]).pipe(
|
shouldPerformSsoLogin$: Observable<boolean> = combineLatest([this.auth.authenticated$, this.auth.isDiscoveryDocumentLoaded$]).pipe(
|
||||||
map(([authenticated, isDiscoveryDocumentLoaded]) => !authenticated && isDiscoveryDocumentLoaded)
|
map(([authenticated, isDiscoveryDocumentLoaded]) => !authenticated && isDiscoveryDocumentLoaded)
|
||||||
|
@ -16,7 +16,18 @@
|
|||||||
*/
|
*/
|
||||||
|
|
||||||
import { Inject, Injectable, inject } from '@angular/core';
|
import { Inject, Injectable, inject } from '@angular/core';
|
||||||
import { AuthConfig, AUTH_CONFIG, OAuthErrorEvent, OAuthEvent, OAuthService, OAuthStorage, TokenResponse, LoginOptions, OAuthSuccessEvent, OAuthLogger } from 'angular-oauth2-oidc';
|
import {
|
||||||
|
AuthConfig,
|
||||||
|
AUTH_CONFIG,
|
||||||
|
OAuthErrorEvent,
|
||||||
|
OAuthEvent,
|
||||||
|
OAuthService,
|
||||||
|
OAuthStorage,
|
||||||
|
TokenResponse,
|
||||||
|
LoginOptions,
|
||||||
|
OAuthSuccessEvent,
|
||||||
|
OAuthLogger
|
||||||
|
} from 'angular-oauth2-oidc';
|
||||||
import { JwksValidationHandler } from 'angular-oauth2-oidc-jwks';
|
import { JwksValidationHandler } from 'angular-oauth2-oidc-jwks';
|
||||||
import { from, Observable, race, ReplaySubject } from 'rxjs';
|
import { from, Observable, race, ReplaySubject } from 'rxjs';
|
||||||
import { distinctUntilChanged, filter, map, shareReplay, switchMap, take } from 'rxjs/operators';
|
import { distinctUntilChanged, filter, map, shareReplay, switchMap, take } from 'rxjs/operators';
|
||||||
@ -29,394 +40,400 @@ const isPromise = <T>(value: T | Promise<T>): value is Promise<T> => value && ty
|
|||||||
|
|
||||||
@Injectable()
|
@Injectable()
|
||||||
export class RedirectAuthService extends AuthService {
|
export class RedirectAuthService extends AuthService {
|
||||||
|
readonly authModuleConfig: AuthModuleConfig = inject(AUTH_MODULE_CONFIG);
|
||||||
|
private readonly _retryLoginService: RetryLoginService = inject(RetryLoginService);
|
||||||
|
private readonly _oauthLogger: OAuthLogger = inject(OAuthLogger);
|
||||||
|
private readonly _timeSyncService: TimeSyncService = inject(TimeSyncService);
|
||||||
|
|
||||||
readonly authModuleConfig: AuthModuleConfig = inject(AUTH_MODULE_CONFIG);
|
private _isDiscoveryDocumentLoadedSubject$ = new ReplaySubject<boolean>();
|
||||||
private readonly _retryLoginService: RetryLoginService = inject(RetryLoginService);
|
public isDiscoveryDocumentLoaded$ = this._isDiscoveryDocumentLoadedSubject$.asObservable();
|
||||||
private readonly _oauthLogger: OAuthLogger = inject(OAuthLogger);
|
|
||||||
private readonly _timeSyncService: TimeSyncService = inject(TimeSyncService);
|
|
||||||
|
|
||||||
private _isDiscoveryDocumentLoadedSubject$ = new ReplaySubject<boolean>();
|
onLogin: Observable<any>;
|
||||||
public isDiscoveryDocumentLoaded$ = this._isDiscoveryDocumentLoadedSubject$.asObservable();
|
|
||||||
|
|
||||||
onLogin: Observable<any>;
|
onTokenReceived: Observable<any>;
|
||||||
|
|
||||||
onTokenReceived: Observable<any>;
|
private _loadDiscoveryDocumentPromise = Promise.resolve(false);
|
||||||
|
|
||||||
private _loadDiscoveryDocumentPromise = Promise.resolve(false);
|
/**
|
||||||
|
* Observable stream that emits when the user logs out.
|
||||||
|
*
|
||||||
|
* This observable listens to the events emitted by the OAuth service and filters
|
||||||
|
* them to only include instances of OAuthSuccessEvent with the type `logout`.
|
||||||
|
*/
|
||||||
|
onLogout$: Observable<void>;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Observable stream that emits when the user logs out.
|
* Observable stream that emits OAuthErrorEvent instances.
|
||||||
*
|
*
|
||||||
* This observable listens to the events emitted by the OAuth service and filters
|
* This observable listens to the events emitted by the OAuth service and filters
|
||||||
* them to only include instances of OAuthSuccessEvent with the type `logout`.
|
* them to only include instances of OAuthErrorEvent. It then maps these events
|
||||||
*
|
* to the correct type.
|
||||||
* @type {Observable<void>}
|
*/
|
||||||
*/
|
oauthErrorEvent$: Observable<OAuthErrorEvent>;
|
||||||
onLogout$: Observable<void>;
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Observable stream that emits OAuthErrorEvent instances.
|
* Observable stream that emits the first OAuth error event that occurs.
|
||||||
*
|
*/
|
||||||
* This observable listens to the events emitted by the OAuth service and filters
|
firstOauthErrorEventOccur$: Observable<OAuthErrorEvent>;
|
||||||
* them to only include instances of OAuthErrorEvent. It then maps these events
|
|
||||||
* to the correct type.
|
|
||||||
*
|
|
||||||
* @type {Observable<OAuthErrorEvent>}
|
|
||||||
*/
|
|
||||||
oauthErrorEvent$: Observable<OAuthErrorEvent>;
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Observable stream that emits the first OAuth error event that occurs.
|
* Observable stream that emits the first OAuth error event that occurs, excluding token refresh errors.
|
||||||
*/
|
*/
|
||||||
firstOauthErrorEventOccur$: Observable<OAuthErrorEvent>;
|
firstOauthErrorEventExcludingTokenRefreshError$: Observable<OAuthErrorEvent>;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Observable stream that emits the first OAuth error event that occurs, excluding token refresh errors.
|
* Observable stream that emits the second OAuth token refresh error event that occurs.
|
||||||
*/
|
*/
|
||||||
firstOauthErrorEventExcludingTokenRefreshError$: Observable<OAuthErrorEvent>;
|
secondTokenRefreshErrorEventOccur$: Observable<OAuthErrorEvent>;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Observable stream that emits the second OAuth token refresh error event that occurs.
|
* Observable that emits an error when the token has expired due to
|
||||||
*/
|
* the local machine clock being out of sync with the server time.
|
||||||
secondTokenRefreshErrorEventOccur$: Observable<OAuthErrorEvent>;
|
*/
|
||||||
|
tokenHasExpiredDueToClockOutOfSync$: Observable<Error>;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Observable that emits an error when the token has expired due to
|
* Observable that emits an error when the OAuth error event occurs due to
|
||||||
* the local machine clock being out of sync with the server time.
|
* the local machine clock being out of sync with the server time.
|
||||||
*
|
*/
|
||||||
* @type {Observable<Error>}
|
oauthErrorEventOccurDueToClockOutOfSync$: Observable<Error>;
|
||||||
*/
|
|
||||||
tokenHasExpiredDueToClockOutOfSync$: Observable<Error>;
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Observable that emits an error when the OAuth error event occurs due to
|
* Observable stream that emits either OAuthErrorEvent or Error.
|
||||||
* the local machine clock being out of sync with the server time.
|
* This stream combines multiple OAuth error sources into a single observable.
|
||||||
*
|
*/
|
||||||
* @type {Observable<Error>}
|
combinedOAuthErrorsStream$: Observable<OAuthErrorEvent | Error>;
|
||||||
*/
|
|
||||||
oauthErrorEventOccurDueToClockOutOfSync$: Observable<Error>;
|
|
||||||
|
|
||||||
/**
|
/** Subscribe to whether the user has valid Id/Access tokens. */
|
||||||
* Observable stream that emits either OAuthErrorEvent or Error.
|
authenticated$!: Observable<boolean>;
|
||||||
* This stream combines multiple OAuth error sources into a single observable.
|
|
||||||
*/
|
|
||||||
combinedOAuthErrorsStream$: Observable<OAuthErrorEvent | Error>;
|
|
||||||
|
|
||||||
/** Subscribe to whether the user has valid Id/Access tokens. */
|
/** Subscribe to errors reaching the IdP. */
|
||||||
authenticated$!: Observable<boolean>;
|
idpUnreachable$!: Observable<Error>;
|
||||||
|
|
||||||
/** Subscribe to errors reaching the IdP. */
|
|
||||||
idpUnreachable$!: Observable<Error>;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Get whether the user has valid Id/Access tokens.
|
|
||||||
*
|
|
||||||
* @returns `true` if the user is authenticated, otherwise `false`
|
|
||||||
*/
|
|
||||||
get authenticated(): boolean {
|
|
||||||
return this.oauthService.hasValidIdToken() && this.oauthService.hasValidAccessToken();
|
|
||||||
}
|
|
||||||
|
|
||||||
private authConfig!: AuthConfig | Promise<AuthConfig>;
|
|
||||||
|
|
||||||
private readonly AUTH_STORAGE_ITEMS: string[] = [
|
|
||||||
'access_token',
|
|
||||||
'access_token_stored_at',
|
|
||||||
'expires_at',
|
|
||||||
'granted_scopes',
|
|
||||||
'id_token',
|
|
||||||
'id_token_claims_obj',
|
|
||||||
'id_token_expires_at',
|
|
||||||
'id_token_stored_at',
|
|
||||||
'nonce',
|
|
||||||
'PKCE_verifier',
|
|
||||||
'refresh_token',
|
|
||||||
'session_state'
|
|
||||||
];
|
|
||||||
|
|
||||||
constructor(
|
|
||||||
private oauthService: OAuthService,
|
|
||||||
private _oauthStorage: OAuthStorage,
|
|
||||||
@Inject(AUTH_CONFIG) authConfig: AuthConfig
|
|
||||||
) {
|
|
||||||
super();
|
|
||||||
|
|
||||||
this.authConfig = authConfig;
|
|
||||||
|
|
||||||
this.oauthService.clearHashAfterLogin = true;
|
|
||||||
|
|
||||||
this.oauthService.events.pipe(
|
|
||||||
filter(() => oauthService.showDebugInformation))
|
|
||||||
.subscribe(event => {
|
|
||||||
if (event instanceof OAuthErrorEvent) {
|
|
||||||
this._oauthLogger.error('OAuthErrorEvent Object:', event);
|
|
||||||
} else {
|
|
||||||
this._oauthLogger.info('OAuthEvent Object:', event);
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
this.oauthErrorEvent$ = this.oauthService.events.pipe(
|
|
||||||
filter(event => event instanceof OAuthErrorEvent),
|
|
||||||
map((event) => event as OAuthErrorEvent)
|
|
||||||
);
|
|
||||||
|
|
||||||
this.firstOauthErrorEventOccur$ = this.oauthErrorEvent$.pipe(take(1));
|
|
||||||
|
|
||||||
this.firstOauthErrorEventExcludingTokenRefreshError$ = this.oauthErrorEvent$.pipe(
|
|
||||||
filter(event => event instanceof OAuthErrorEvent && event.type !== 'token_refresh_error'),
|
|
||||||
take(1)
|
|
||||||
);
|
|
||||||
|
|
||||||
this.secondTokenRefreshErrorEventOccur$ = this.oauthErrorEvent$.pipe(
|
|
||||||
filter(event => event.type === 'token_refresh_error'),
|
|
||||||
take(2),
|
|
||||||
filter((_, index) => index === 1)
|
|
||||||
);
|
|
||||||
|
|
||||||
this.oauthErrorEventOccurDueToClockOutOfSync$ = this.oauthErrorEvent$.pipe(
|
|
||||||
switchMap(() => this._timeSyncService.checkTimeSync(this.oauthService.clockSkewInSec)),
|
|
||||||
filter((timeSync) => timeSync?.outOfSync),
|
|
||||||
map((timeSync) => new Error(`OAuth error occurred due to local machine clock ${timeSync.localDateTimeISO} being out of sync with server time ${timeSync.serverDateTimeISO}`)),
|
|
||||||
take(1)
|
|
||||||
);
|
|
||||||
|
|
||||||
this.authenticated$ = this.oauthService.events.pipe(
|
|
||||||
map(() => this.authenticated),
|
|
||||||
distinctUntilChanged(),
|
|
||||||
shareReplay(1)
|
|
||||||
);
|
|
||||||
|
|
||||||
this.tokenHasExpiredDueToClockOutOfSync$ = this.oauthService.events.pipe(
|
|
||||||
map(() => !!this.oauthService.getIdentityClaims() && this.tokenHasExpired()),
|
|
||||||
filter((hasExpired) => hasExpired),
|
|
||||||
switchMap(() => this._timeSyncService.checkTimeSync(this.oauthService.clockSkewInSec)),
|
|
||||||
filter((timeSync) => timeSync?.outOfSync),
|
|
||||||
map((timeSync) => new Error(`Token has expired due to local machine clock ${timeSync.localDateTimeISO} being out of sync with server time ${timeSync.serverDateTimeISO}`)),
|
|
||||||
take(1)
|
|
||||||
);
|
|
||||||
|
|
||||||
this.onLogout$ = this.oauthService.events.pipe(
|
|
||||||
filter((event) => event.type === 'logout'),
|
|
||||||
map(() => undefined)
|
|
||||||
);
|
|
||||||
|
|
||||||
this.combinedOAuthErrorsStream$ = race([
|
|
||||||
this.oauthErrorEventOccurDueToClockOutOfSync$,
|
|
||||||
this.firstOauthErrorEventExcludingTokenRefreshError$,
|
|
||||||
this.tokenHasExpiredDueToClockOutOfSync$,
|
|
||||||
this.secondTokenRefreshErrorEventOccur$
|
|
||||||
]);
|
|
||||||
|
|
||||||
this.combinedOAuthErrorsStream$.subscribe({
|
|
||||||
next: (res) => {
|
|
||||||
this._oauthLogger.error(res);
|
|
||||||
this.logout();
|
|
||||||
},
|
|
||||||
error: () => {}
|
|
||||||
});
|
|
||||||
|
|
||||||
this.oauthService.events.pipe(take(1)).subscribe(() => {
|
|
||||||
if(this.oauthService.getAccessToken() && !this.oauthService.hasValidAccessToken()) {
|
|
||||||
if(this.oauthService.showDebugInformation) {
|
|
||||||
this._oauthLogger.warn('Access token not valid. Removing all auth items from storage');
|
|
||||||
}
|
|
||||||
this.AUTH_STORAGE_ITEMS.map((item: string) => this._oauthStorage.removeItem(item));
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
this.onLogin = this.authenticated$.pipe(
|
|
||||||
filter((authenticated) => authenticated),
|
|
||||||
map(() => undefined)
|
|
||||||
);
|
|
||||||
|
|
||||||
this.onTokenReceived = this.oauthService.events.pipe(
|
|
||||||
filter((event: OAuthEvent) => event.type === 'token_received'),
|
|
||||||
map(() => undefined)
|
|
||||||
);
|
|
||||||
|
|
||||||
this.idpUnreachable$ = this.oauthService.events.pipe(
|
|
||||||
filter((event): event is OAuthErrorEvent => event.type === 'discovery_document_load_error'),
|
|
||||||
map((event) => event.reason as Error)
|
|
||||||
);
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get whether the user has valid Id/Access tokens.
|
||||||
|
*
|
||||||
|
* @returns `true` if the user is authenticated, otherwise `false`
|
||||||
|
*/
|
||||||
|
get authenticated(): boolean {
|
||||||
|
return this.oauthService.hasValidIdToken() && this.oauthService.hasValidAccessToken();
|
||||||
}
|
}
|
||||||
|
|
||||||
init(): Promise<boolean> {
|
private authConfig!: AuthConfig | Promise<AuthConfig>;
|
||||||
if (isPromise(this.authConfig)) {
|
|
||||||
return this.authConfig.then((config) => this.configureAuth(config));
|
|
||||||
}
|
|
||||||
|
|
||||||
return this.configureAuth(this.authConfig);
|
private readonly AUTH_STORAGE_ITEMS: string[] = [
|
||||||
}
|
'access_token',
|
||||||
|
'access_token_stored_at',
|
||||||
|
'expires_at',
|
||||||
|
'granted_scopes',
|
||||||
|
'id_token',
|
||||||
|
'id_token_claims_obj',
|
||||||
|
'id_token_expires_at',
|
||||||
|
'id_token_stored_at',
|
||||||
|
'nonce',
|
||||||
|
'PKCE_verifier',
|
||||||
|
'refresh_token',
|
||||||
|
'session_state'
|
||||||
|
];
|
||||||
|
|
||||||
logout() {
|
constructor(private oauthService: OAuthService, private _oauthStorage: OAuthStorage, @Inject(AUTH_CONFIG) authConfig: AuthConfig) {
|
||||||
this.oauthService.logOut();
|
super();
|
||||||
}
|
|
||||||
|
|
||||||
ensureDiscoveryDocument(): Promise<boolean> {
|
this.authConfig = authConfig;
|
||||||
this._loadDiscoveryDocumentPromise = this._loadDiscoveryDocumentPromise
|
|
||||||
.catch(() => false)
|
|
||||||
.then((loaded) => {
|
|
||||||
if (!loaded) {
|
|
||||||
return this.oauthService.loadDiscoveryDocument().then(() => true);
|
|
||||||
}
|
|
||||||
return true;
|
|
||||||
});
|
|
||||||
return this._loadDiscoveryDocumentPromise;
|
|
||||||
}
|
|
||||||
|
|
||||||
|
this.oauthService.clearHashAfterLogin = true;
|
||||||
|
|
||||||
login(currentUrl?: string): void {
|
this.oauthService.events.pipe(filter(() => oauthService.showDebugInformation)).subscribe((event) => {
|
||||||
let stateKey: string | undefined;
|
if (event instanceof OAuthErrorEvent) {
|
||||||
|
this._oauthLogger.error('OAuthErrorEvent Object:', event);
|
||||||
if (currentUrl) {
|
|
||||||
const randomValue = window.crypto.getRandomValues(new Uint32Array(1))[0];
|
|
||||||
stateKey = `auth_state_${randomValue}${Date.now()}`;
|
|
||||||
this._oauthStorage.setItem(stateKey, JSON.stringify(currentUrl || {}));
|
|
||||||
}
|
|
||||||
|
|
||||||
// initLoginFlow will initialize the login flow in either code or implicit depending on the configuration
|
|
||||||
this.ensureDiscoveryDocument().then(() => void this.oauthService.initLoginFlow(stateKey));
|
|
||||||
}
|
|
||||||
|
|
||||||
baseAuthLogin(username: string, password: string): Observable<TokenResponse> {
|
|
||||||
this.oauthService.useHttpBasicAuth = true;
|
|
||||||
|
|
||||||
return from(this.oauthService.fetchTokenUsingPasswordFlow(username, password)).pipe(
|
|
||||||
map((response) => {
|
|
||||||
const props = new Map<string, string>();
|
|
||||||
props.set('id_token', response.id_token);
|
|
||||||
// for backward compatibility we need to set the response in our storage
|
|
||||||
this.oauthService['storeAccessTokenResponse'](response.access_token, response.refresh_token, response.expires_in, response.scope, props);
|
|
||||||
return response;
|
|
||||||
})
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
async loginCallback(loginOptions?: LoginOptions): Promise<string | undefined> {
|
|
||||||
return this.ensureDiscoveryDocument()
|
|
||||||
.then(() => this._retryLoginService.tryToLoginTimes({ ...loginOptions, preventClearHashAfterLogin: this.authModuleConfig.preventClearHashAfterLogin }))
|
|
||||||
.then(() => this._getRedirectUrl());
|
|
||||||
}
|
|
||||||
|
|
||||||
private _getRedirectUrl() {
|
|
||||||
const DEFAULT_REDIRECT = '/';
|
|
||||||
const stateKey = this.oauthService.state;
|
|
||||||
|
|
||||||
if (stateKey) {
|
|
||||||
const stateStringified = this._oauthStorage.getItem(stateKey);
|
|
||||||
if (stateStringified) {
|
|
||||||
// cleanup state from storage
|
|
||||||
this._oauthStorage.removeItem(stateKey);
|
|
||||||
return JSON.parse(stateStringified);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return DEFAULT_REDIRECT;
|
|
||||||
}
|
|
||||||
|
|
||||||
private configureAuth(config: AuthConfig): Promise<boolean> {
|
|
||||||
this.oauthService.configure(config);
|
|
||||||
this.oauthService.tokenValidationHandler = new JwksValidationHandler();
|
|
||||||
|
|
||||||
if (config.sessionChecksEnabled) {
|
|
||||||
this.oauthService.events.pipe(filter((event) => event.type === 'session_terminated')).subscribe(() => {
|
|
||||||
this.oauthService.logOut();
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
return this.ensureDiscoveryDocument().then(() => {
|
|
||||||
this._isDiscoveryDocumentLoadedSubject$.next(true);
|
|
||||||
this.oauthService.setupAutomaticSilentRefresh();
|
|
||||||
return void this.allowRefreshTokenAndSilentRefreshOnMultipleTabs();
|
|
||||||
}).catch(() => {
|
|
||||||
// catch error to prevent the app from crashing when trying to access unprotected routes
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Fix a known issue (https://github.com/manfredsteyer/angular-oauth2-oidc/issues/850)
|
|
||||||
* where multiple tabs can cause the token refresh and the silent refresh to fail.
|
|
||||||
* This patch is based on the solutions provided in the following comments:
|
|
||||||
* https://github.com/manfredsteyer/angular-oauth2-oidc/issues/850#issuecomment-889921776 fix silent refresh for the implicit flow
|
|
||||||
* https://github.com/manfredsteyer/angular-oauth2-oidc/issues/850#issuecomment-1557286966 fix refresh token for the code flow
|
|
||||||
*/
|
|
||||||
private allowRefreshTokenAndSilentRefreshOnMultipleTabs() {
|
|
||||||
let lastUpdatedAccessToken: string | undefined;
|
|
||||||
|
|
||||||
if (this.oauthService.hasValidAccessToken()) {
|
|
||||||
lastUpdatedAccessToken = this.oauthService.getAccessToken();
|
|
||||||
}
|
|
||||||
|
|
||||||
const originalRefreshToken = this.oauthService.refreshToken.bind(this.oauthService);
|
|
||||||
this.oauthService.refreshToken = (): Promise<TokenResponse> =>
|
|
||||||
navigator.locks.request(`refresh_tokens_${location.origin}`, () => {
|
|
||||||
if (!!lastUpdatedAccessToken && lastUpdatedAccessToken !== this.oauthService.getAccessToken()) {
|
|
||||||
(this.oauthService as any).eventsSubject.next(new OAuthSuccessEvent('token_received'));
|
|
||||||
(this.oauthService as any).eventsSubject.next(new OAuthSuccessEvent('token_refreshed'));
|
|
||||||
lastUpdatedAccessToken = this.oauthService.getAccessToken();
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
return originalRefreshToken().then((resp) => (lastUpdatedAccessToken = resp.access_token));
|
|
||||||
});
|
|
||||||
|
|
||||||
const originalSilentRefresh = this.oauthService.silentRefresh.bind(this.oauthService);
|
|
||||||
this.oauthService.silentRefresh = async (params: any = {}, noPrompt = true): Promise<OAuthEvent> =>
|
|
||||||
navigator.locks.request(`silent_refresh_${location.origin}`, async (): Promise<OAuthEvent> => {
|
|
||||||
if (lastUpdatedAccessToken !== this.oauthService.getAccessToken()) {
|
|
||||||
(this.oauthService as any).eventsSubject.next(new OAuthSuccessEvent('token_received'));
|
|
||||||
(this.oauthService as any).eventsSubject.next(new OAuthSuccessEvent('token_refreshed'));
|
|
||||||
const event = new OAuthSuccessEvent('silently_refreshed');
|
|
||||||
(this.oauthService as any).eventsSubject.next(event);
|
|
||||||
lastUpdatedAccessToken = this.oauthService.getAccessToken();
|
|
||||||
return event;
|
|
||||||
} else {
|
} else {
|
||||||
return originalSilentRefresh(params, noPrompt);
|
this._oauthLogger.info('OAuthEvent Object:', event);
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
}
|
|
||||||
|
|
||||||
updateIDPConfiguration(config: AuthConfig) {
|
this.oauthErrorEvent$ = this.oauthService.events.pipe(
|
||||||
this.oauthService.configure(config);
|
filter((event) => event instanceof OAuthErrorEvent),
|
||||||
}
|
map((event) => event as OAuthErrorEvent)
|
||||||
|
);
|
||||||
|
|
||||||
|
this.firstOauthErrorEventOccur$ = this.oauthErrorEvent$.pipe(take(1));
|
||||||
|
|
||||||
/**
|
this.firstOauthErrorEventExcludingTokenRefreshError$ = this.oauthErrorEvent$.pipe(
|
||||||
* Checks if the token has expired.
|
filter((event) => event instanceof OAuthErrorEvent && event.type !== 'token_refresh_error'),
|
||||||
*
|
take(1)
|
||||||
* This method retrieves the identity claims from the OAuth service and calculates
|
);
|
||||||
* the token's issued and expiration times. It then compares the current time with
|
|
||||||
* these values, considering a clock skew and a configurable expiration decrease.
|
this.secondTokenRefreshErrorEventOccur$ = this.oauthErrorEvent$.pipe(
|
||||||
*
|
filter((event) => event.type === 'token_refresh_error'),
|
||||||
* @returns - Returns `true` if the token has expired, otherwise `false`.
|
take(2),
|
||||||
*/
|
filter((_, index) => index === 1)
|
||||||
tokenHasExpired(){
|
);
|
||||||
const claims = this.oauthService.getIdentityClaims();
|
|
||||||
if(!claims){
|
this.oauthErrorEventOccurDueToClockOutOfSync$ = this.oauthErrorEvent$.pipe(
|
||||||
this._oauthLogger.warn('No claims found in the token');
|
switchMap(() => this._timeSyncService.checkTimeSync(this.oauthService.clockSkewInSec)),
|
||||||
return false;
|
filter((timeSync) => timeSync?.outOfSync),
|
||||||
|
map(
|
||||||
|
(timeSync) =>
|
||||||
|
new Error(
|
||||||
|
`OAuth error occurred due to local machine clock ${timeSync.localDateTimeISO} being out of sync with server time ${timeSync.serverDateTimeISO}`
|
||||||
|
)
|
||||||
|
),
|
||||||
|
take(1)
|
||||||
|
);
|
||||||
|
|
||||||
|
this.authenticated$ = this.oauthService.events.pipe(
|
||||||
|
map(() => this.authenticated),
|
||||||
|
distinctUntilChanged(),
|
||||||
|
shareReplay(1)
|
||||||
|
);
|
||||||
|
|
||||||
|
this.tokenHasExpiredDueToClockOutOfSync$ = this.oauthService.events.pipe(
|
||||||
|
map(() => !!this.oauthService.getIdentityClaims() && this.tokenHasExpired()),
|
||||||
|
filter((hasExpired) => hasExpired),
|
||||||
|
switchMap(() => this._timeSyncService.checkTimeSync(this.oauthService.clockSkewInSec)),
|
||||||
|
filter((timeSync) => timeSync?.outOfSync),
|
||||||
|
map(
|
||||||
|
(timeSync) =>
|
||||||
|
new Error(
|
||||||
|
`Token has expired due to local machine clock ${timeSync.localDateTimeISO} being out of sync with server time ${timeSync.serverDateTimeISO}`
|
||||||
|
)
|
||||||
|
),
|
||||||
|
take(1)
|
||||||
|
);
|
||||||
|
|
||||||
|
this.onLogout$ = this.oauthService.events.pipe(
|
||||||
|
filter((event) => event.type === 'logout'),
|
||||||
|
map(() => undefined)
|
||||||
|
);
|
||||||
|
|
||||||
|
this.combinedOAuthErrorsStream$ = race([
|
||||||
|
this.oauthErrorEventOccurDueToClockOutOfSync$,
|
||||||
|
this.firstOauthErrorEventExcludingTokenRefreshError$,
|
||||||
|
this.tokenHasExpiredDueToClockOutOfSync$,
|
||||||
|
this.secondTokenRefreshErrorEventOccur$
|
||||||
|
]);
|
||||||
|
|
||||||
|
this.combinedOAuthErrorsStream$.subscribe({
|
||||||
|
next: (res) => {
|
||||||
|
this._oauthLogger.error(res);
|
||||||
|
this.logout();
|
||||||
|
},
|
||||||
|
error: () => {}
|
||||||
|
});
|
||||||
|
|
||||||
|
this.oauthService.events.pipe(take(1)).subscribe(() => {
|
||||||
|
if (this.oauthService.getAccessToken() && !this.oauthService.hasValidAccessToken()) {
|
||||||
|
if (this.oauthService.showDebugInformation) {
|
||||||
|
this._oauthLogger.warn('Access token not valid. Removing all auth items from storage');
|
||||||
|
}
|
||||||
|
this.AUTH_STORAGE_ITEMS.map((item: string) => this._oauthStorage.removeItem(item));
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
this.onLogin = this.authenticated$.pipe(
|
||||||
|
filter((authenticated) => authenticated),
|
||||||
|
map(() => undefined)
|
||||||
|
);
|
||||||
|
|
||||||
|
this.onTokenReceived = this.oauthService.events.pipe(
|
||||||
|
filter((event: OAuthEvent) => event.type === 'token_received'),
|
||||||
|
map(() => undefined)
|
||||||
|
);
|
||||||
|
|
||||||
|
this.idpUnreachable$ = this.oauthService.events.pipe(
|
||||||
|
filter((event): event is OAuthErrorEvent => event.type === 'discovery_document_load_error'),
|
||||||
|
map((event) => event.reason as Error)
|
||||||
|
);
|
||||||
}
|
}
|
||||||
const now = Date.now();
|
|
||||||
const issuedAtMSec = claims.iat * 1000;
|
|
||||||
const expiresAtMSec = claims.exp * 1000;
|
|
||||||
const clockSkewInMSec = this.oauthService.clockSkewInSec * 1000;
|
|
||||||
|
|
||||||
this.showTokenExpiredDebugInformations(now, issuedAtMSec, expiresAtMSec, clockSkewInMSec);
|
init(): Promise<boolean> {
|
||||||
return issuedAtMSec - clockSkewInMSec >= now ||
|
if (isPromise(this.authConfig)) {
|
||||||
expiresAtMSec + clockSkewInMSec - this.oauthService.decreaseExpirationBySec <= now;
|
return this.authConfig.then((config) => this.configureAuth(config));
|
||||||
}
|
}
|
||||||
|
|
||||||
private showTokenExpiredDebugInformations(now: number, issuedAtMSec: number, expiresAtMSec: number, clockSkewInMSec: number) {
|
return this.configureAuth(this.authConfig);
|
||||||
if(this.oauthService.showDebugInformation) {
|
|
||||||
this._oauthLogger.warn('now: ', new Date(now));
|
|
||||||
this._oauthLogger.warn('issuedAt: ', new Date(issuedAtMSec));
|
|
||||||
this._oauthLogger.warn('expiresAt: ', new Date(expiresAtMSec));
|
|
||||||
this._oauthLogger.warn('clockSkewInMSec: ', clockSkewInMSec);
|
|
||||||
this._oauthLogger.warn('this.oauthService.decreaseExpirationBySec: ', this.oauthService.decreaseExpirationBySec);
|
|
||||||
this._oauthLogger.warn('issuedAtMSec - clockSkewInMSec >= now: ', issuedAtMSec - clockSkewInMSec >= now);
|
|
||||||
this._oauthLogger.warn('expiresAtMSec + clockSkewInMSec - this.oauthService.decreaseExpirationBySec <= now: ', expiresAtMSec + clockSkewInMSec - this.oauthService.decreaseExpirationBySec <= now);
|
|
||||||
}
|
}
|
||||||
}
|
|
||||||
|
|
||||||
|
logout() {
|
||||||
|
this.oauthService.logOut();
|
||||||
|
}
|
||||||
|
|
||||||
|
ensureDiscoveryDocument(): Promise<boolean> {
|
||||||
|
this._loadDiscoveryDocumentPromise = this._loadDiscoveryDocumentPromise
|
||||||
|
.catch(() => false)
|
||||||
|
.then((loaded) => {
|
||||||
|
if (!loaded) {
|
||||||
|
return this.oauthService.loadDiscoveryDocument().then(() => true);
|
||||||
|
}
|
||||||
|
return true;
|
||||||
|
});
|
||||||
|
return this._loadDiscoveryDocumentPromise;
|
||||||
|
}
|
||||||
|
|
||||||
|
login(currentUrl?: string): void {
|
||||||
|
let stateKey: string | undefined;
|
||||||
|
|
||||||
|
if (currentUrl) {
|
||||||
|
const randomValue = window.crypto.getRandomValues(new Uint32Array(1))[0];
|
||||||
|
stateKey = `auth_state_${randomValue}${Date.now()}`;
|
||||||
|
this._oauthStorage.setItem(stateKey, JSON.stringify(currentUrl || {}));
|
||||||
|
}
|
||||||
|
|
||||||
|
// initLoginFlow will initialize the login flow in either code or implicit depending on the configuration
|
||||||
|
this.ensureDiscoveryDocument().then(() => void this.oauthService.initLoginFlow(stateKey));
|
||||||
|
}
|
||||||
|
|
||||||
|
baseAuthLogin(username: string, password: string): Observable<TokenResponse> {
|
||||||
|
this.oauthService.useHttpBasicAuth = true;
|
||||||
|
|
||||||
|
return from(this.oauthService.fetchTokenUsingPasswordFlow(username, password)).pipe(
|
||||||
|
map((response) => {
|
||||||
|
const props = new Map<string, string>();
|
||||||
|
props.set('id_token', response.id_token);
|
||||||
|
// for backward compatibility we need to set the response in our storage
|
||||||
|
this.oauthService['storeAccessTokenResponse'](
|
||||||
|
response.access_token,
|
||||||
|
response.refresh_token,
|
||||||
|
response.expires_in,
|
||||||
|
response.scope,
|
||||||
|
props
|
||||||
|
);
|
||||||
|
return response;
|
||||||
|
})
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
async loginCallback(loginOptions?: LoginOptions): Promise<string | undefined> {
|
||||||
|
return this.ensureDiscoveryDocument()
|
||||||
|
.then(() =>
|
||||||
|
this._retryLoginService.tryToLoginTimes({
|
||||||
|
...loginOptions,
|
||||||
|
preventClearHashAfterLogin: this.authModuleConfig.preventClearHashAfterLogin
|
||||||
|
})
|
||||||
|
)
|
||||||
|
.then(() => this._getRedirectUrl());
|
||||||
|
}
|
||||||
|
|
||||||
|
private _getRedirectUrl() {
|
||||||
|
const DEFAULT_REDIRECT = '/';
|
||||||
|
const stateKey = this.oauthService.state;
|
||||||
|
|
||||||
|
if (stateKey) {
|
||||||
|
const stateStringified = this._oauthStorage.getItem(stateKey);
|
||||||
|
if (stateStringified) {
|
||||||
|
// cleanup state from storage
|
||||||
|
this._oauthStorage.removeItem(stateKey);
|
||||||
|
return JSON.parse(stateStringified);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return DEFAULT_REDIRECT;
|
||||||
|
}
|
||||||
|
|
||||||
|
private configureAuth(config: AuthConfig): Promise<boolean> {
|
||||||
|
this.oauthService.configure(config);
|
||||||
|
this.oauthService.tokenValidationHandler = new JwksValidationHandler();
|
||||||
|
|
||||||
|
if (config.sessionChecksEnabled) {
|
||||||
|
this.oauthService.events.pipe(filter((event) => event.type === 'session_terminated')).subscribe(() => {
|
||||||
|
this.oauthService.logOut();
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
return this.ensureDiscoveryDocument()
|
||||||
|
.then(() => {
|
||||||
|
this._isDiscoveryDocumentLoadedSubject$.next(true);
|
||||||
|
this.oauthService.setupAutomaticSilentRefresh();
|
||||||
|
return void this.allowRefreshTokenAndSilentRefreshOnMultipleTabs();
|
||||||
|
})
|
||||||
|
.catch(() => {
|
||||||
|
// catch error to prevent the app from crashing when trying to access unprotected routes
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Fix a known issue (https://github.com/manfredsteyer/angular-oauth2-oidc/issues/850)
|
||||||
|
* where multiple tabs can cause the token refresh and the silent refresh to fail.
|
||||||
|
* This patch is based on the solutions provided in the following comments:
|
||||||
|
* https://github.com/manfredsteyer/angular-oauth2-oidc/issues/850#issuecomment-889921776 fix silent refresh for the implicit flow
|
||||||
|
* https://github.com/manfredsteyer/angular-oauth2-oidc/issues/850#issuecomment-1557286966 fix refresh token for the code flow
|
||||||
|
*/
|
||||||
|
private allowRefreshTokenAndSilentRefreshOnMultipleTabs() {
|
||||||
|
let lastUpdatedAccessToken: string | undefined;
|
||||||
|
|
||||||
|
if (this.oauthService.hasValidAccessToken()) {
|
||||||
|
lastUpdatedAccessToken = this.oauthService.getAccessToken();
|
||||||
|
}
|
||||||
|
|
||||||
|
const originalRefreshToken = this.oauthService.refreshToken.bind(this.oauthService);
|
||||||
|
this.oauthService.refreshToken = (): Promise<TokenResponse> =>
|
||||||
|
navigator.locks.request(`refresh_tokens_${location.origin}`, () => {
|
||||||
|
if (!!lastUpdatedAccessToken && lastUpdatedAccessToken !== this.oauthService.getAccessToken()) {
|
||||||
|
(this.oauthService as any).eventsSubject.next(new OAuthSuccessEvent('token_received'));
|
||||||
|
(this.oauthService as any).eventsSubject.next(new OAuthSuccessEvent('token_refreshed'));
|
||||||
|
lastUpdatedAccessToken = this.oauthService.getAccessToken();
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
return originalRefreshToken().then((resp) => (lastUpdatedAccessToken = resp.access_token));
|
||||||
|
});
|
||||||
|
|
||||||
|
const originalSilentRefresh = this.oauthService.silentRefresh.bind(this.oauthService);
|
||||||
|
this.oauthService.silentRefresh = async (params: any = {}, noPrompt = true): Promise<OAuthEvent> =>
|
||||||
|
navigator.locks.request(`silent_refresh_${location.origin}`, async (): Promise<OAuthEvent> => {
|
||||||
|
if (lastUpdatedAccessToken !== this.oauthService.getAccessToken()) {
|
||||||
|
(this.oauthService as any).eventsSubject.next(new OAuthSuccessEvent('token_received'));
|
||||||
|
(this.oauthService as any).eventsSubject.next(new OAuthSuccessEvent('token_refreshed'));
|
||||||
|
const event = new OAuthSuccessEvent('silently_refreshed');
|
||||||
|
(this.oauthService as any).eventsSubject.next(event);
|
||||||
|
lastUpdatedAccessToken = this.oauthService.getAccessToken();
|
||||||
|
return event;
|
||||||
|
} else {
|
||||||
|
return originalSilentRefresh(params, noPrompt);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
updateIDPConfiguration(config: AuthConfig) {
|
||||||
|
this.oauthService.configure(config);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Checks if the token has expired.
|
||||||
|
*
|
||||||
|
* This method retrieves the identity claims from the OAuth service and calculates
|
||||||
|
* the token's issued and expiration times. It then compares the current time with
|
||||||
|
* these values, considering a clock skew and a configurable expiration decrease.
|
||||||
|
*
|
||||||
|
* @returns - Returns `true` if the token has expired, otherwise `false`.
|
||||||
|
*/
|
||||||
|
tokenHasExpired() {
|
||||||
|
const claims = this.oauthService.getIdentityClaims();
|
||||||
|
if (!claims) {
|
||||||
|
this._oauthLogger.warn('No claims found in the token');
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
const now = Date.now();
|
||||||
|
const issuedAtMSec = claims.iat * 1000;
|
||||||
|
const expiresAtMSec = claims.exp * 1000;
|
||||||
|
const clockSkewInMSec = this.oauthService.clockSkewInSec * 1000;
|
||||||
|
|
||||||
|
this.showTokenExpiredDebugInformations(now, issuedAtMSec, expiresAtMSec, clockSkewInMSec);
|
||||||
|
return issuedAtMSec - clockSkewInMSec >= now || expiresAtMSec + clockSkewInMSec - this.oauthService.decreaseExpirationBySec <= now;
|
||||||
|
}
|
||||||
|
|
||||||
|
private showTokenExpiredDebugInformations(now: number, issuedAtMSec: number, expiresAtMSec: number, clockSkewInMSec: number) {
|
||||||
|
if (this.oauthService.showDebugInformation) {
|
||||||
|
this._oauthLogger.warn('now: ', new Date(now));
|
||||||
|
this._oauthLogger.warn('issuedAt: ', new Date(issuedAtMSec));
|
||||||
|
this._oauthLogger.warn('expiresAt: ', new Date(expiresAtMSec));
|
||||||
|
this._oauthLogger.warn('clockSkewInMSec: ', clockSkewInMSec);
|
||||||
|
this._oauthLogger.warn('this.oauthService.decreaseExpirationBySec: ', this.oauthService.decreaseExpirationBySec);
|
||||||
|
this._oauthLogger.warn('issuedAtMSec - clockSkewInMSec >= now: ', issuedAtMSec - clockSkewInMSec >= now);
|
||||||
|
this._oauthLogger.warn(
|
||||||
|
'expiresAtMSec + clockSkewInMSec - this.oauthService.decreaseExpirationBySec <= now: ',
|
||||||
|
expiresAtMSec + clockSkewInMSec - this.oauthService.decreaseExpirationBySec <= now
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
@ -33,8 +33,6 @@ import { OAuthService, OAuthStorage } from 'angular-oauth2-oidc';
|
|||||||
*
|
*
|
||||||
* See the related issue: https://github.com/manfredsteyer/angular-oauth2-oidc/issues/1443
|
* See the related issue: https://github.com/manfredsteyer/angular-oauth2-oidc/issues/1443
|
||||||
*
|
*
|
||||||
* @implements {HttpInterceptor}
|
|
||||||
* @class
|
|
||||||
* @function intercept
|
* @function intercept
|
||||||
* @param {HttpRequest<unknown>} request - The outgoing HTTP request.
|
* @param {HttpRequest<unknown>} request - The outgoing HTTP request.
|
||||||
* @param {HttpHandler} next - The next handler in the HTTP request chain.
|
* @param {HttpHandler} next - The next handler in the HTTP request chain.
|
||||||
|
@ -44,7 +44,6 @@ export class LocationCellComponent extends DataTableCellComponent implements OnI
|
|||||||
super.ngOnInit();
|
super.ngOnInit();
|
||||||
}
|
}
|
||||||
|
|
||||||
/** @override */
|
|
||||||
protected updateValue(): void {
|
protected updateValue(): void {
|
||||||
if (this.column?.key && this.column?.format && this.row && this.data) {
|
if (this.column?.key && this.column?.format && this.row && this.data) {
|
||||||
const path: PathInfo = this.data.getValue(this.row, this.column, this.resolverFn);
|
const path: PathInfo = this.data.getValue(this.row, this.column, this.resolverFn);
|
||||||
|
@ -146,8 +146,6 @@ export class FormModel implements ProcessFormModel {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Validates entire form and all form fields.
|
* Validates entire form and all form fields.
|
||||||
*
|
|
||||||
* @memberof FormModel
|
|
||||||
*/
|
*/
|
||||||
validateForm(): void {
|
validateForm(): void {
|
||||||
const validateFormEvent: any = new ValidateFormEvent(this);
|
const validateFormEvent: any = new ValidateFormEvent(this);
|
||||||
@ -173,7 +171,6 @@ export class FormModel implements ProcessFormModel {
|
|||||||
* Validates a specific form field, triggers form validation.
|
* Validates a specific form field, triggers form validation.
|
||||||
*
|
*
|
||||||
* @param field Form field to validate.
|
* @param field Form field to validate.
|
||||||
* @memberof FormModel
|
|
||||||
*/
|
*/
|
||||||
validateField(field: FormFieldModel): void {
|
validateField(field: FormFieldModel): void {
|
||||||
if (!field) {
|
if (!field) {
|
||||||
|
@ -20,22 +20,18 @@ import { CookieService } from '../common/services/cookie.service';
|
|||||||
|
|
||||||
@Injectable()
|
@Injectable()
|
||||||
export class CookieServiceMock extends CookieService {
|
export class CookieServiceMock extends CookieService {
|
||||||
/** @override */
|
|
||||||
isEnabled(): boolean {
|
isEnabled(): boolean {
|
||||||
return true;
|
return true;
|
||||||
}
|
}
|
||||||
|
|
||||||
/** @override */
|
|
||||||
getItem(key: string): string | null {
|
getItem(key: string): string | null {
|
||||||
return this[key]?.data || null;
|
return this[key]?.data || null;
|
||||||
}
|
}
|
||||||
|
|
||||||
/** @override */
|
|
||||||
setItem(key: string, data: string, expiration: Date | null, path: string | null): void {
|
setItem(key: string, data: string, expiration: Date | null, path: string | null): void {
|
||||||
this[key] = { data, expiration, path };
|
this[key] = { data, expiration, path };
|
||||||
}
|
}
|
||||||
|
|
||||||
/** @override */
|
|
||||||
clear() {
|
clear() {
|
||||||
Object.keys(this).forEach((key) => {
|
Object.keys(this).forEach((key) => {
|
||||||
if (Object.prototype.hasOwnProperty.call(this, key) && typeof this[key] !== 'function') {
|
if (Object.prototype.hasOwnProperty.call(this, key) && typeof this[key] !== 'function') {
|
||||||
|
@ -43,31 +43,23 @@ export class AppExtensionService {
|
|||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
const references = (config.$references || [])
|
const references = (config.$references || []).filter((entry) => typeof entry === 'object').map((entry) => entry as ExtensionRef);
|
||||||
.filter((entry) => typeof entry === 'object')
|
|
||||||
.map((entry) => entry as ExtensionRef);
|
|
||||||
this._references.next(references);
|
this._references.next(references);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Provides a collection of document list columns for the particular preset.
|
* Provides a collection of document list columns for the particular preset.
|
||||||
* The result is filtered by the **disabled** state.
|
* The result is filtered by the **disabled** state.
|
||||||
*
|
|
||||||
* @param key Preset key.
|
* @param key Preset key.
|
||||||
* @returns list of document list presets
|
* @returns list of document list presets
|
||||||
*/
|
*/
|
||||||
getDocumentListPreset(key: string): DocumentListPresetRef[] {
|
getDocumentListPreset(key: string): DocumentListPresetRef[] {
|
||||||
return this.extensionService
|
return this.extensionService.getElements<DocumentListPresetRef>(`features.documentList.${key}`).filter((entry) => !entry.disabled);
|
||||||
.getElements<DocumentListPresetRef>(
|
|
||||||
`features.documentList.${key}`
|
|
||||||
)
|
|
||||||
.filter((entry) => !entry.disabled);
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Provides a list of the Viewer content extensions,
|
* Provides a list of the Viewer content extensions,
|
||||||
* filtered by **disabled** state and **rules**.
|
* filtered by **disabled** state and **rules**.
|
||||||
*
|
|
||||||
* @returns list of viewer extension references
|
* @returns list of viewer extension references
|
||||||
*/
|
*/
|
||||||
getViewerExtensions(): ViewerExtensionRef[] {
|
getViewerExtensions(): ViewerExtensionRef[] {
|
||||||
@ -78,13 +70,13 @@ export class AppExtensionService {
|
|||||||
|
|
||||||
protected isViewerExtensionDisabled(extension: ViewerExtensionRef): boolean {
|
protected isViewerExtensionDisabled(extension: ViewerExtensionRef): boolean {
|
||||||
if (extension) {
|
if (extension) {
|
||||||
if (extension.disabled) {
|
if (extension.disabled) {
|
||||||
return true;
|
return true;
|
||||||
}
|
}
|
||||||
|
|
||||||
if (extension.rules?.disabled) {
|
if (extension.rules?.disabled) {
|
||||||
return this.extensionService.evaluateRule(extension.rules.disabled);
|
return this.extensionService.evaluateRule(extension.rules.disabled);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
return false;
|
return false;
|
||||||
|
@ -28,15 +28,9 @@ import { RuleRef } from '../config/rule.extensions';
|
|||||||
providedIn: 'root'
|
providedIn: 'root'
|
||||||
})
|
})
|
||||||
export class ExtensionLoaderService {
|
export class ExtensionLoaderService {
|
||||||
constructor(private http: HttpClient) {
|
constructor(private http: HttpClient) {}
|
||||||
}
|
|
||||||
|
|
||||||
load(
|
load(configPath: string, pluginsPath: string, extensions?: string[], extensionValues?: ExtensionConfig[]): Promise<ExtensionConfig> {
|
||||||
configPath: string,
|
|
||||||
pluginsPath: string,
|
|
||||||
extensions?: string[],
|
|
||||||
extensionValues?: ExtensionConfig[]
|
|
||||||
): Promise<ExtensionConfig> {
|
|
||||||
return new Promise<any>((resolve) => {
|
return new Promise<any>((resolve) => {
|
||||||
this.loadConfig(configPath, 0).then((result) => {
|
this.loadConfig(configPath, 0).then((result) => {
|
||||||
if (result) {
|
if (result) {
|
||||||
@ -54,9 +48,7 @@ export class ExtensionLoaderService {
|
|||||||
}
|
}
|
||||||
|
|
||||||
if (config.$references?.length > 0 || extensionValues) {
|
if (config.$references?.length > 0 || extensionValues) {
|
||||||
const plugins = (config.$references ?? []).map((name, idx) =>
|
const plugins = (config.$references ?? []).map((name, idx) => this.loadConfig(`${pluginsPath}/${name}`, idx));
|
||||||
this.loadConfig(`${pluginsPath}/${name}`, idx)
|
|
||||||
);
|
|
||||||
|
|
||||||
Promise.all(plugins).then((results) => {
|
Promise.all(plugins).then((results) => {
|
||||||
let configs = results
|
let configs = results
|
||||||
@ -65,13 +57,9 @@ export class ExtensionLoaderService {
|
|||||||
.map((entry) => entry.config);
|
.map((entry) => entry.config);
|
||||||
|
|
||||||
if (extensionValues) {
|
if (extensionValues) {
|
||||||
configs = [
|
configs = [...configs, ...extensionValues];
|
||||||
...configs,
|
|
||||||
...extensionValues
|
|
||||||
];
|
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
if (configs.length > 0) {
|
if (configs.length > 0) {
|
||||||
config = mergeObjects(config, ...configs);
|
config = mergeObjects(config, ...configs);
|
||||||
}
|
}
|
||||||
@ -96,26 +84,18 @@ export class ExtensionLoaderService {
|
|||||||
* Retrieves configuration elements.
|
* Retrieves configuration elements.
|
||||||
* Filters element by **enabled** and **order** attributes.
|
* Filters element by **enabled** and **order** attributes.
|
||||||
* Example:
|
* Example:
|
||||||
* `getElements<ViewerExtensionRef>(config, 'features.viewer.extensions')`
|
* `getElements<ViewerExtensionRef>(config, 'features.viewer.extensions')`
|
||||||
*
|
|
||||||
* @param config configuration settings
|
* @param config configuration settings
|
||||||
* @param key element key
|
* @param key element key
|
||||||
* @param fallback fallback array of values
|
* @param fallback fallback array of values
|
||||||
* @returns list of elements
|
* @returns list of elements
|
||||||
*/
|
*/
|
||||||
getElements<T extends ExtensionElement>(
|
getElements<T extends ExtensionElement>(config: ExtensionConfig, key: string, fallback: Array<T> = []): Array<T> {
|
||||||
config: ExtensionConfig,
|
|
||||||
key: string,
|
|
||||||
fallback: Array<T> = []
|
|
||||||
): Array<T> {
|
|
||||||
const values = getValue(config, key) || fallback || [];
|
const values = getValue(config, key) || fallback || [];
|
||||||
return values.filter(filterEnabled).sort(sortByOrder);
|
return values.filter(filterEnabled).sort(sortByOrder);
|
||||||
}
|
}
|
||||||
|
|
||||||
getContentActions(
|
getContentActions(config: ExtensionConfig, key: string): Array<ContentActionRef> {
|
||||||
config: ExtensionConfig,
|
|
||||||
key: string
|
|
||||||
): Array<ContentActionRef> {
|
|
||||||
return this.getElements(config, key).map(this.setActionDefaults);
|
return this.getElements(config, key).map(this.setActionDefaults);
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -150,8 +130,7 @@ export class ExtensionLoaderService {
|
|||||||
protected getMetadata(config: ExtensionConfig): ExtensionRef {
|
protected getMetadata(config: ExtensionConfig): ExtensionRef {
|
||||||
const result: any = {};
|
const result: any = {};
|
||||||
|
|
||||||
Object
|
Object.keys(config)
|
||||||
.keys(config)
|
|
||||||
.filter((key) => key.startsWith('$'))
|
.filter((key) => key.startsWith('$'))
|
||||||
.forEach((key) => {
|
.forEach((key) => {
|
||||||
result[key] = config[key];
|
result[key] = config[key];
|
||||||
@ -160,10 +139,7 @@ export class ExtensionLoaderService {
|
|||||||
return result;
|
return result;
|
||||||
}
|
}
|
||||||
|
|
||||||
protected loadConfig(
|
protected loadConfig(url: string, order: number): Promise<{ order: number; config: ExtensionConfig }> {
|
||||||
url: string,
|
|
||||||
order: number
|
|
||||||
): Promise<{ order: number; config: ExtensionConfig }> {
|
|
||||||
return new Promise((resolve) => {
|
return new Promise((resolve) => {
|
||||||
this.http.get<ExtensionConfig>(url).subscribe(
|
this.http.get<ExtensionConfig>(url).subscribe(
|
||||||
(config) => {
|
(config) => {
|
||||||
|
@ -29,7 +29,6 @@ import { BehaviorSubject, Observable } from 'rxjs';
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* The default extensions factory
|
* The default extensions factory
|
||||||
*
|
|
||||||
* @returns the list of extension json files
|
* @returns the list of extension json files
|
||||||
*/
|
*/
|
||||||
export function extensionJsonsFactory() {
|
export function extensionJsonsFactory() {
|
||||||
@ -48,7 +47,6 @@ export const EXTENSION_JSON_VALUES = new InjectionToken<string[][]>('extension-j
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Provides the extension json values for the angular modules
|
* Provides the extension json values for the angular modules
|
||||||
*
|
|
||||||
* @param jsons files to provide
|
* @param jsons files to provide
|
||||||
* @returns a provider section
|
* @returns a provider section
|
||||||
*/
|
*/
|
||||||
@ -62,7 +60,6 @@ export function provideExtensionConfig(jsons: string[]) {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Provides the extension json raw values for the angular modules
|
* Provides the extension json raw values for the angular modules
|
||||||
*
|
|
||||||
* @param extensionConfigValue config value
|
* @param extensionConfigValue config value
|
||||||
* @returns a provider section
|
* @returns a provider section
|
||||||
*/
|
*/
|
||||||
@ -103,7 +100,6 @@ export class ExtensionService {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Loads and registers an extension config file and plugins (specified by path properties).
|
* Loads and registers an extension config file and plugins (specified by path properties).
|
||||||
*
|
|
||||||
* @returns The loaded config data
|
* @returns The loaded config data
|
||||||
*/
|
*/
|
||||||
async load(): Promise<ExtensionConfig> {
|
async load(): Promise<ExtensionConfig> {
|
||||||
@ -115,7 +111,6 @@ export class ExtensionService {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Registers extensions from a config object.
|
* Registers extensions from a config object.
|
||||||
*
|
|
||||||
* @param config Object with config data
|
* @param config Object with config data
|
||||||
*/
|
*/
|
||||||
setup(config: ExtensionConfig) {
|
setup(config: ExtensionConfig) {
|
||||||
@ -142,7 +137,6 @@ export class ExtensionService {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Gets features by key.
|
* Gets features by key.
|
||||||
*
|
|
||||||
* @param key Key string using dot notation or array of strings
|
* @param key Key string using dot notation or array of strings
|
||||||
* @param defaultValue Default value returned if feature is not found, default is empty array
|
* @param defaultValue Default value returned if feature is not found, default is empty array
|
||||||
* @returns Feature found by key
|
* @returns Feature found by key
|
||||||
@ -158,7 +152,6 @@ export class ExtensionService {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Adds one or more new rule evaluators to the existing set.
|
* Adds one or more new rule evaluators to the existing set.
|
||||||
*
|
|
||||||
* @param values The new evaluators to add
|
* @param values The new evaluators to add
|
||||||
*/
|
*/
|
||||||
setEvaluators(values: { [key: string]: RuleEvaluator }) {
|
setEvaluators(values: { [key: string]: RuleEvaluator }) {
|
||||||
@ -167,7 +160,6 @@ export class ExtensionService {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Adds one or more new auth guards to the existing set.
|
* Adds one or more new auth guards to the existing set.
|
||||||
*
|
|
||||||
* @param values The new auth guards to add
|
* @param values The new auth guards to add
|
||||||
*/
|
*/
|
||||||
setAuthGuards(values: Record<string, unknown>) {
|
setAuthGuards(values: Record<string, unknown>) {
|
||||||
@ -178,7 +170,6 @@ export class ExtensionService {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Adds one or more new components to the existing set.
|
* Adds one or more new components to the existing set.
|
||||||
*
|
|
||||||
* @param values The new components to add
|
* @param values The new components to add
|
||||||
*/
|
*/
|
||||||
setComponents(values: { [key: string]: Type<any> }) {
|
setComponents(values: { [key: string]: Type<any> }) {
|
||||||
@ -187,7 +178,6 @@ export class ExtensionService {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Retrieves a route using its ID value.
|
* Retrieves a route using its ID value.
|
||||||
*
|
|
||||||
* @param id The ID value to look for
|
* @param id The ID value to look for
|
||||||
* @returns The route or null if not found
|
* @returns The route or null if not found
|
||||||
*/
|
*/
|
||||||
@ -197,7 +187,6 @@ export class ExtensionService {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Retrieves one or more auth guards using an array of ID values.
|
* Retrieves one or more auth guards using an array of ID values.
|
||||||
*
|
|
||||||
* @param ids Array of ID value to look for
|
* @param ids Array of ID value to look for
|
||||||
* @returns Array of auth guards or empty array if none were found
|
* @returns Array of auth guards or empty array if none were found
|
||||||
*/
|
*/
|
||||||
@ -207,7 +196,6 @@ export class ExtensionService {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Retrieves an action using its ID value.
|
* Retrieves an action using its ID value.
|
||||||
*
|
|
||||||
* @param id The ID value to look for
|
* @param id The ID value to look for
|
||||||
* @returns Action or null if not found
|
* @returns Action or null if not found
|
||||||
*/
|
*/
|
||||||
@ -217,7 +205,6 @@ export class ExtensionService {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Retrieves a RuleEvaluator function using its key name.
|
* Retrieves a RuleEvaluator function using its key name.
|
||||||
*
|
|
||||||
* @param key Key name to look for
|
* @param key Key name to look for
|
||||||
* @returns RuleEvaluator or null if not found
|
* @returns RuleEvaluator or null if not found
|
||||||
*/
|
*/
|
||||||
@ -227,7 +214,6 @@ export class ExtensionService {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Evaluates a rule.
|
* Evaluates a rule.
|
||||||
*
|
|
||||||
* @param ruleId ID of the rule to evaluate
|
* @param ruleId ID of the rule to evaluate
|
||||||
* @param context Custom rule execution context.
|
* @param context Custom rule execution context.
|
||||||
* @returns True if the rule passed, false otherwise
|
* @returns True if the rule passed, false otherwise
|
||||||
@ -238,7 +224,6 @@ export class ExtensionService {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Retrieves a registered extension component using its ID value.
|
* Retrieves a registered extension component using its ID value.
|
||||||
*
|
|
||||||
* @param id The ID value to look for
|
* @param id The ID value to look for
|
||||||
* @returns The component or null if not found
|
* @returns The component or null if not found
|
||||||
*/
|
*/
|
||||||
@ -248,7 +233,6 @@ export class ExtensionService {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Retrieves a rule using its ID value.
|
* Retrieves a rule using its ID value.
|
||||||
*
|
|
||||||
* @param id The ID value to look for
|
* @param id The ID value to look for
|
||||||
* @returns The rule or null if not found
|
* @returns The rule or null if not found
|
||||||
*/
|
*/
|
||||||
@ -258,7 +242,6 @@ export class ExtensionService {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Runs a lightweight expression stored in a string.
|
* Runs a lightweight expression stored in a string.
|
||||||
*
|
|
||||||
* @param value String containing the expression or literal value
|
* @param value String containing the expression or literal value
|
||||||
* @param context Parameter object for the expression with details of app state
|
* @param context Parameter object for the expression with details of app state
|
||||||
* @returns Result of evaluated expression, if found, or the literal value otherwise
|
* @returns Result of evaluated expression, if found, or the literal value otherwise
|
||||||
|
@ -36,7 +36,6 @@ export class RuleService {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Adds one or more new rule evaluators to the existing set.
|
* Adds one or more new rule evaluators to the existing set.
|
||||||
*
|
|
||||||
* @param values The new evaluators to add
|
* @param values The new evaluators to add
|
||||||
*/
|
*/
|
||||||
setEvaluators(values: { [key: string]: RuleEvaluator }) {
|
setEvaluators(values: { [key: string]: RuleEvaluator }) {
|
||||||
@ -47,7 +46,6 @@ export class RuleService {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Retrieves a rule using its ID value.
|
* Retrieves a rule using its ID value.
|
||||||
*
|
|
||||||
* @param id The ID value to look for
|
* @param id The ID value to look for
|
||||||
* @returns The rule or null if not found
|
* @returns The rule or null if not found
|
||||||
*/
|
*/
|
||||||
@ -57,7 +55,6 @@ export class RuleService {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Retrieves a RuleEvaluator function using its key name.
|
* Retrieves a RuleEvaluator function using its key name.
|
||||||
*
|
|
||||||
* @param key Key name to look for
|
* @param key Key name to look for
|
||||||
* @returns RuleEvaluator or null if not found
|
* @returns RuleEvaluator or null if not found
|
||||||
*/
|
*/
|
||||||
@ -71,7 +68,6 @@ export class RuleService {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Evaluates a rule.
|
* Evaluates a rule.
|
||||||
*
|
|
||||||
* @param ruleId ID of the rule to evaluate
|
* @param ruleId ID of the rule to evaluate
|
||||||
* @param context Custom rule execution context.
|
* @param context Custom rule execution context.
|
||||||
* @returns True if the rule passed, false otherwise
|
* @returns True if the rule passed, false otherwise
|
||||||
|
@ -85,7 +85,6 @@ export class AnalyticsReportListComponent implements OnInit {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Reload the component
|
* Reload the component
|
||||||
*
|
|
||||||
* @param reportId report id
|
* @param reportId report id
|
||||||
*/
|
*/
|
||||||
reload(reportId?: number) {
|
reload(reportId?: number) {
|
||||||
@ -95,7 +94,6 @@ export class AnalyticsReportListComponent implements OnInit {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get the report list
|
* Get the report list
|
||||||
*
|
|
||||||
* @param appId application id
|
* @param appId application id
|
||||||
* @param reportId report id
|
* @param reportId report id
|
||||||
*/
|
*/
|
||||||
@ -139,7 +137,6 @@ export class AnalyticsReportListComponent implements OnInit {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Check if the report list is empty
|
* Check if the report list is empty
|
||||||
*
|
|
||||||
* @returns `true` if report list is empty, otherwise `false`
|
* @returns `true` if report list is empty, otherwise `false`
|
||||||
*/
|
*/
|
||||||
isReportsEmpty(): boolean {
|
isReportsEmpty(): boolean {
|
||||||
@ -148,7 +145,6 @@ export class AnalyticsReportListComponent implements OnInit {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Select the current report
|
* Select the current report
|
||||||
*
|
|
||||||
* @param report report model
|
* @param report report model
|
||||||
*/
|
*/
|
||||||
selectReport(report: ReportParametersModel) {
|
selectReport(report: ReportParametersModel) {
|
||||||
|
@ -50,7 +50,6 @@ export class AnalyticsService {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Retrieve all the Deployed app
|
* Retrieve all the Deployed app
|
||||||
*
|
|
||||||
* @param appId application id
|
* @param appId application id
|
||||||
* @returns list or report parameter models
|
* @returns list or report parameter models
|
||||||
*/
|
*/
|
||||||
@ -71,7 +70,6 @@ export class AnalyticsService {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Retrieve Report by name
|
* Retrieve Report by name
|
||||||
*
|
|
||||||
* @param reportName - The name of report
|
* @param reportName - The name of report
|
||||||
* @returns report model
|
* @returns report model
|
||||||
*/
|
*/
|
||||||
|
@ -98,7 +98,6 @@ export class DiagramTooltipComponent implements AfterViewInit, OnDestroy {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Calculates the tooltip position and displays it
|
* Calculates the tooltip position and displays it
|
||||||
*
|
|
||||||
* @param event mouseenter/touchend event
|
* @param event mouseenter/touchend event
|
||||||
*/
|
*/
|
||||||
private handleMouseEnter(event): void {
|
private handleMouseEnter(event): void {
|
||||||
|
@ -304,7 +304,6 @@ export class AlfrescoApi implements Emitter, AlfrescoApiType {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* login Alfresco API
|
* login Alfresco API
|
||||||
*
|
|
||||||
* @param username Username to login
|
* @param username Username to login
|
||||||
* @param password Password to login
|
* @param password Password to login
|
||||||
* @returns A promise that returns {new authentication ticket} if resolved and {error} if rejected.
|
* @returns A promise that returns {new authentication ticket} if resolved and {error} if rejected.
|
||||||
@ -383,7 +382,6 @@ export class AlfrescoApi implements Emitter, AlfrescoApiType {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* login Tickets
|
* login Tickets
|
||||||
*
|
|
||||||
* @param ticketEcm alfresco ticket
|
* @param ticketEcm alfresco ticket
|
||||||
* @param ticketBpm alfresco ticket
|
* @param ticketBpm alfresco ticket
|
||||||
*/
|
*/
|
||||||
@ -558,7 +556,6 @@ export class AlfrescoApi implements Emitter, AlfrescoApiType {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Set the current Ticket
|
* Set the current Ticket
|
||||||
*
|
|
||||||
* @param ticketEcm ecm ticket
|
* @param ticketEcm ecm ticket
|
||||||
* @param ticketBpm bpm ticket
|
* @param ticketBpm bpm ticket
|
||||||
*/
|
*/
|
||||||
|
@ -35,7 +35,6 @@ export type AlfrescoApiClientPromise<T = any> = Promise<T> & {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Builds a string representation of an array-type actual parameter, according to the given collection format.
|
* Builds a string representation of an array-type actual parameter, according to the given collection format.
|
||||||
*
|
|
||||||
* @param param An array parameter.
|
* @param param An array parameter.
|
||||||
* @param collectionFormat The array element separator strategy.
|
* @param collectionFormat The array element separator strategy.
|
||||||
* @returns A string representation of the supplied collection, using the specified delimiter. Returns
|
* @returns A string representation of the supplied collection, using the specified delimiter. Returns
|
||||||
@ -343,7 +342,6 @@ export class AlfrescoApiClient implements ee.Emitter, LegacyHttpClient {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Chooses a content type from the given array, with JSON preferred; i.e. return JSON if included, otherwise return the first.
|
* Chooses a content type from the given array, with JSON preferred; i.e. return JSON if included, otherwise return the first.
|
||||||
*
|
|
||||||
* @param contentTypes content types
|
* @param contentTypes content types
|
||||||
* @returns The chosen content type, preferring JSON.
|
* @returns The chosen content type, preferring JSON.
|
||||||
*/
|
*/
|
||||||
@ -369,7 +367,6 @@ export class AlfrescoApiClient implements ee.Emitter, LegacyHttpClient {
|
|||||||
* <li>application/json; charset=UTF8</li>
|
* <li>application/json; charset=UTF8</li>
|
||||||
* <li>APPLICATION/JSON</li>
|
* <li>APPLICATION/JSON</li>
|
||||||
* </ul>
|
* </ul>
|
||||||
*
|
|
||||||
* @param contentType The MIME content type to check.
|
* @param contentType The MIME content type to check.
|
||||||
* @returns <code>true</code> if <code>contentType</code> represents JSON, otherwise <code>false</code>.
|
* @returns <code>true</code> if <code>contentType</code> represents JSON, otherwise <code>false</code>.
|
||||||
*/
|
*/
|
||||||
|
@ -24,7 +24,6 @@ export class AboutApi extends BaseApi {
|
|||||||
/**
|
/**
|
||||||
* Get server type and version
|
* Get server type and version
|
||||||
* Provides information about the running Alfresco Process Services Suite. The response payload object has the properties type, majorVersion, minorVersion, revisionVersion and edition.
|
* Provides information about the running Alfresco Process Services Suite. The response payload object has the properties type, majorVersion, minorVersion, revisionVersion and edition.
|
||||||
*
|
|
||||||
* @return Promise<{ [key: string]: string; }>
|
* @return Promise<{ [key: string]: string; }>
|
||||||
*/
|
*/
|
||||||
getAppVersion(): Promise<{ [key: string]: string }> {
|
getAppVersion(): Promise<{ [key: string]: string }> {
|
||||||
|
@ -25,7 +25,6 @@ export class AccountIntegrationApi extends BaseApi {
|
|||||||
/**
|
/**
|
||||||
* Retrieve external account information
|
* Retrieve external account information
|
||||||
* Accounts are used to integrate with third party apps and clients
|
* Accounts are used to integrate with third party apps and clients
|
||||||
*
|
|
||||||
* @return Promise<ResultListDataRepresentationAccountRepresentation>
|
* @return Promise<ResultListDataRepresentationAccountRepresentation>
|
||||||
*/
|
*/
|
||||||
getAccounts(): Promise<ResultListDataRepresentationAccountRepresentation> {
|
getAccounts(): Promise<ResultListDataRepresentationAccountRepresentation> {
|
||||||
|
@ -25,7 +25,6 @@ import { throwIfNotDefined } from '../../../assert';
|
|||||||
export class AdminEndpointsApi extends BaseApi {
|
export class AdminEndpointsApi extends BaseApi {
|
||||||
/**
|
/**
|
||||||
* Add an endpoint authorization
|
* Add an endpoint authorization
|
||||||
*
|
|
||||||
* @param createRepresentation createRepresentation
|
* @param createRepresentation createRepresentation
|
||||||
* @return Promise<EndpointBasicAuthRepresentation>
|
* @return Promise<EndpointBasicAuthRepresentation>
|
||||||
*/
|
*/
|
||||||
@ -41,7 +40,6 @@ export class AdminEndpointsApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Create an endpoint
|
* Create an endpoint
|
||||||
*
|
|
||||||
* @param representation representation
|
* @param representation representation
|
||||||
* @return Promise<EndpointConfigurationRepresentation>
|
* @return Promise<EndpointConfigurationRepresentation>
|
||||||
*/
|
*/
|
||||||
@ -56,7 +54,6 @@ export class AdminEndpointsApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get an endpoint authorization
|
* Get an endpoint authorization
|
||||||
*
|
|
||||||
* @param basicAuthId basicAuthId
|
* @param basicAuthId basicAuthId
|
||||||
* @param tenantId tenantId
|
* @param tenantId tenantId
|
||||||
* @return Promise<EndpointBasicAuthRepresentation>
|
* @return Promise<EndpointBasicAuthRepresentation>
|
||||||
@ -83,7 +80,6 @@ export class AdminEndpointsApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* List endpoint authorizations
|
* List endpoint authorizations
|
||||||
*
|
|
||||||
* @param tenantId tenantId
|
* @param tenantId tenantId
|
||||||
* @return Promise<EndpointBasicAuthRepresentation>
|
* @return Promise<EndpointBasicAuthRepresentation>
|
||||||
*/
|
*/
|
||||||
@ -103,7 +99,6 @@ export class AdminEndpointsApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get an endpoint
|
* Get an endpoint
|
||||||
*
|
|
||||||
* @param endpointConfigurationId endpointConfigurationId
|
* @param endpointConfigurationId endpointConfigurationId
|
||||||
* @param tenantId tenantId
|
* @param tenantId tenantId
|
||||||
* @return Promise<EndpointConfigurationRepresentation>
|
* @return Promise<EndpointConfigurationRepresentation>
|
||||||
@ -129,7 +124,6 @@ export class AdminEndpointsApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* List endpoints
|
* List endpoints
|
||||||
*
|
|
||||||
* @param tenantId tenantId
|
* @param tenantId tenantId
|
||||||
* @return Promise<EndpointConfigurationRepresentation>
|
* @return Promise<EndpointConfigurationRepresentation>
|
||||||
*/
|
*/
|
||||||
@ -148,7 +142,6 @@ export class AdminEndpointsApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Delete an endpoint authorization
|
* Delete an endpoint authorization
|
||||||
*
|
|
||||||
* @param basicAuthId basicAuthId
|
* @param basicAuthId basicAuthId
|
||||||
* @param tenantId tenantId
|
* @param tenantId tenantId
|
||||||
* @return Promise<{}>
|
* @return Promise<{}>
|
||||||
@ -174,7 +167,6 @@ export class AdminEndpointsApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Delete an endpoint
|
* Delete an endpoint
|
||||||
*
|
|
||||||
* @param endpointConfigurationId endpointConfigurationId
|
* @param endpointConfigurationId endpointConfigurationId
|
||||||
* @param tenantId tenantId
|
* @param tenantId tenantId
|
||||||
* @return Promise<{}>
|
* @return Promise<{}>
|
||||||
@ -200,7 +192,6 @@ export class AdminEndpointsApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Update an endpoint authorization
|
* Update an endpoint authorization
|
||||||
*
|
|
||||||
* @param basicAuthId basicAuthId
|
* @param basicAuthId basicAuthId
|
||||||
* @param createRepresentation createRepresentation
|
* @param createRepresentation createRepresentation
|
||||||
* @return Promise<EndpointBasicAuthRepresentation>
|
* @return Promise<EndpointBasicAuthRepresentation>
|
||||||
@ -226,7 +217,6 @@ export class AdminEndpointsApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Update an endpoint
|
* Update an endpoint
|
||||||
*
|
|
||||||
* @param endpointConfigurationId endpointConfigurationId
|
* @param endpointConfigurationId endpointConfigurationId
|
||||||
* @param representation representation
|
* @param representation representation
|
||||||
* @return Promise<EndpointConfigurationRepresentation>
|
* @return Promise<EndpointConfigurationRepresentation>
|
||||||
|
@ -31,7 +31,6 @@ import { throwIfNotDefined } from '../../../assert';
|
|||||||
export class AdminGroupsApi extends BaseApi {
|
export class AdminGroupsApi extends BaseApi {
|
||||||
/**
|
/**
|
||||||
* Activate a group
|
* Activate a group
|
||||||
*
|
|
||||||
* @param groupId groupId
|
* @param groupId groupId
|
||||||
* @return Promise<{}>
|
* @return Promise<{}>
|
||||||
*/
|
*/
|
||||||
@ -50,7 +49,6 @@ export class AdminGroupsApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Add users to a group
|
* Add users to a group
|
||||||
*
|
|
||||||
* @param groupId groupId
|
* @param groupId groupId
|
||||||
* @return Promise<{}>
|
* @return Promise<{}>
|
||||||
*/
|
*/
|
||||||
@ -69,7 +67,6 @@ export class AdminGroupsApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Add capabilities to a group
|
* Add capabilities to a group
|
||||||
*
|
|
||||||
* @param groupId groupId
|
* @param groupId groupId
|
||||||
* @param addGroupCapabilitiesRepresentation addGroupCapabilitiesRepresentation
|
* @param addGroupCapabilitiesRepresentation addGroupCapabilitiesRepresentation
|
||||||
* @return Promise<{}>
|
* @return Promise<{}>
|
||||||
@ -91,7 +88,6 @@ export class AdminGroupsApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Add a user to a group
|
* Add a user to a group
|
||||||
*
|
|
||||||
* @param groupId groupId
|
* @param groupId groupId
|
||||||
* @param userId userId
|
* @param userId userId
|
||||||
* @return Promise<{}>
|
* @return Promise<{}>
|
||||||
@ -113,7 +109,6 @@ export class AdminGroupsApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get a related group
|
* Get a related group
|
||||||
*
|
|
||||||
* @param groupId groupId
|
* @param groupId groupId
|
||||||
* @param relatedGroupId relatedGroupId
|
* @param relatedGroupId relatedGroupId
|
||||||
* @param type type
|
* @param type type
|
||||||
@ -142,7 +137,6 @@ export class AdminGroupsApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Create a group
|
* Create a group
|
||||||
*
|
|
||||||
* @param groupRepresentation groupRepresentation
|
* @param groupRepresentation groupRepresentation
|
||||||
* @return Promise<GroupRepresentation>
|
* @return Promise<GroupRepresentation>
|
||||||
*/
|
*/
|
||||||
@ -158,7 +152,6 @@ export class AdminGroupsApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Remove a capability from a group
|
* Remove a capability from a group
|
||||||
*
|
|
||||||
* @param groupId groupId
|
* @param groupId groupId
|
||||||
* @param groupCapabilityId groupCapabilityId
|
* @param groupCapabilityId groupCapabilityId
|
||||||
* @return Promise<{}>
|
* @return Promise<{}>
|
||||||
@ -180,7 +173,6 @@ export class AdminGroupsApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Delete a member from a group
|
* Delete a member from a group
|
||||||
*
|
|
||||||
* @param groupId groupId
|
* @param groupId groupId
|
||||||
* @param userId userId
|
* @param userId userId
|
||||||
* @return Promise<{}>
|
* @return Promise<{}>
|
||||||
@ -202,7 +194,6 @@ export class AdminGroupsApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Delete a group
|
* Delete a group
|
||||||
*
|
|
||||||
* @param groupId groupId
|
* @param groupId groupId
|
||||||
* @return Promise<{}>
|
* @return Promise<{}>
|
||||||
*/
|
*/
|
||||||
@ -221,7 +212,6 @@ export class AdminGroupsApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Delete a related group
|
* Delete a related group
|
||||||
*
|
|
||||||
* @param groupId groupId
|
* @param groupId groupId
|
||||||
* @param relatedGroupId relatedGroupId
|
* @param relatedGroupId relatedGroupId
|
||||||
* @return Promise<{}>
|
* @return Promise<{}>
|
||||||
@ -243,7 +233,6 @@ export class AdminGroupsApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* List group capabilities
|
* List group capabilities
|
||||||
*
|
|
||||||
* @param groupId groupId
|
* @param groupId groupId
|
||||||
* @return Promise<string>
|
* @return Promise<string>
|
||||||
*/
|
*/
|
||||||
@ -262,7 +251,6 @@ export class AdminGroupsApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get group members
|
* Get group members
|
||||||
*
|
|
||||||
* @param groupId groupId
|
* @param groupId groupId
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
* @return Promise<ResultListDataRepresentationLightUserRepresentation>
|
* @return Promise<ResultListDataRepresentationLightUserRepresentation>
|
||||||
@ -286,7 +274,6 @@ export class AdminGroupsApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get a group
|
* Get a group
|
||||||
*
|
|
||||||
* @param groupId groupId
|
* @param groupId groupId
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
* @return Promise<AbstractGroupRepresentation>
|
* @return Promise<AbstractGroupRepresentation>
|
||||||
@ -307,7 +294,6 @@ export class AdminGroupsApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Query groups
|
* Query groups
|
||||||
*
|
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
* @return Promise<LightGroupRepresentation>
|
* @return Promise<LightGroupRepresentation>
|
||||||
*/
|
*/
|
||||||
@ -320,7 +306,6 @@ export class AdminGroupsApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get related groups
|
* Get related groups
|
||||||
*
|
|
||||||
* @param groupId groupId
|
* @param groupId groupId
|
||||||
* @return Promise<LightGroupRepresentation>
|
* @return Promise<LightGroupRepresentation>
|
||||||
*/
|
*/
|
||||||
@ -339,7 +324,6 @@ export class AdminGroupsApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Update a group
|
* Update a group
|
||||||
*
|
|
||||||
* @param groupId groupId
|
* @param groupId groupId
|
||||||
* @param groupRepresentation groupRepresentation
|
* @param groupRepresentation groupRepresentation
|
||||||
* @return Promise<GroupRepresentation>
|
* @return Promise<GroupRepresentation>
|
||||||
|
@ -26,7 +26,6 @@ export class AdminTenantsApi extends BaseApi {
|
|||||||
/**
|
/**
|
||||||
* Create a tenant
|
* Create a tenant
|
||||||
* Only a tenant manager may access this endpoint
|
* Only a tenant manager may access this endpoint
|
||||||
*
|
|
||||||
* @param createTenantRepresentation createTenantRepresentation
|
* @param createTenantRepresentation createTenantRepresentation
|
||||||
* @return Promise<LightTenantRepresentation>
|
* @return Promise<LightTenantRepresentation>
|
||||||
*/
|
*/
|
||||||
@ -41,7 +40,6 @@ export class AdminTenantsApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Delete a tenant
|
* Delete a tenant
|
||||||
*
|
|
||||||
* @param tenantId tenantId
|
* @param tenantId tenantId
|
||||||
* @return Promise<{}>
|
* @return Promise<{}>
|
||||||
*/
|
*/
|
||||||
@ -60,7 +58,6 @@ export class AdminTenantsApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get tenant events
|
* Get tenant events
|
||||||
*
|
|
||||||
* @param tenantId tenantId
|
* @param tenantId tenantId
|
||||||
* @return Promise<TenantEvent>
|
* @return Promise<TenantEvent>
|
||||||
*/
|
*/
|
||||||
@ -80,7 +77,6 @@ export class AdminTenantsApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get a tenant's logo
|
* Get a tenant's logo
|
||||||
*
|
|
||||||
* @param tenantId tenantId
|
* @param tenantId tenantId
|
||||||
* @return Promise<{}>
|
* @return Promise<{}>
|
||||||
*/
|
*/
|
||||||
@ -99,7 +95,6 @@ export class AdminTenantsApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get a tenant
|
* Get a tenant
|
||||||
*
|
|
||||||
* @param tenantId tenantId
|
* @param tenantId tenantId
|
||||||
* @return Promise<TenantRepresentation>
|
* @return Promise<TenantRepresentation>
|
||||||
*/
|
*/
|
||||||
@ -120,7 +115,6 @@ export class AdminTenantsApi extends BaseApi {
|
|||||||
/**
|
/**
|
||||||
* List tenants
|
* List tenants
|
||||||
* Only a tenant manager may access this endpoint
|
* Only a tenant manager may access this endpoint
|
||||||
*
|
|
||||||
* @return Promise<LightTenantRepresentation>
|
* @return Promise<LightTenantRepresentation>
|
||||||
*/
|
*/
|
||||||
getTenants(): Promise<LightTenantRepresentation> {
|
getTenants(): Promise<LightTenantRepresentation> {
|
||||||
@ -131,7 +125,6 @@ export class AdminTenantsApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Update a tenant
|
* Update a tenant
|
||||||
*
|
|
||||||
* @param tenantId tenantId
|
* @param tenantId tenantId
|
||||||
* @param createTenantRepresentation createTenantRepresentation
|
* @param createTenantRepresentation createTenantRepresentation
|
||||||
* @return Promise<TenantRepresentation>
|
* @return Promise<TenantRepresentation>
|
||||||
@ -154,7 +147,6 @@ export class AdminTenantsApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Update a tenant's logo
|
* Update a tenant's logo
|
||||||
*
|
|
||||||
* @param tenantId tenantId
|
* @param tenantId tenantId
|
||||||
* @param file file
|
* @param file file
|
||||||
* @return Promise<ImageUploadRepresentation>
|
* @return Promise<ImageUploadRepresentation>
|
||||||
|
@ -44,7 +44,6 @@ export interface GetUsersOpts {
|
|||||||
export class AdminUsersApi extends BaseApi {
|
export class AdminUsersApi extends BaseApi {
|
||||||
/**
|
/**
|
||||||
* Bulk update a list of users
|
* Bulk update a list of users
|
||||||
*
|
|
||||||
* @param update update
|
* @param update update
|
||||||
* @return Promise<{}>
|
* @return Promise<{}>
|
||||||
*/
|
*/
|
||||||
@ -59,7 +58,6 @@ export class AdminUsersApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Create a user
|
* Create a user
|
||||||
*
|
|
||||||
* @param userRepresentation userRepresentation
|
* @param userRepresentation userRepresentation
|
||||||
* @return Promise<UserRepresentation>
|
* @return Promise<UserRepresentation>
|
||||||
*/
|
*/
|
||||||
@ -75,7 +73,6 @@ export class AdminUsersApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get a user
|
* Get a user
|
||||||
*
|
|
||||||
* @param userId userId
|
* @param userId userId
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
* @return Promise<AbstractUserRepresentation>
|
* @return Promise<AbstractUserRepresentation>
|
||||||
@ -96,7 +93,6 @@ export class AdminUsersApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Query users
|
* Query users
|
||||||
*
|
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
* @return Promise<ResultListDataRepresentationAbstractUserRepresentation>
|
* @return Promise<ResultListDataRepresentationAbstractUserRepresentation>
|
||||||
*/
|
*/
|
||||||
@ -109,7 +105,6 @@ export class AdminUsersApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Update a user
|
* Update a user
|
||||||
*
|
|
||||||
* @param userId userId
|
* @param userId userId
|
||||||
* @param userRepresentation userRepresentation
|
* @param userRepresentation userRepresentation
|
||||||
* @return Promise<{}>
|
* @return Promise<{}>
|
||||||
|
@ -30,7 +30,6 @@ import { throwIfNotDefined } from '../../../assert';
|
|||||||
export class AppDefinitionsApi extends BaseApi {
|
export class AppDefinitionsApi extends BaseApi {
|
||||||
/**
|
/**
|
||||||
* deleteAppDefinition
|
* deleteAppDefinition
|
||||||
*
|
|
||||||
* @param appDefinitionId appDefinitionId
|
* @param appDefinitionId appDefinitionId
|
||||||
* @return Promise<{}>
|
* @return Promise<{}>
|
||||||
*/
|
*/
|
||||||
@ -51,7 +50,6 @@ export class AppDefinitionsApi extends BaseApi {
|
|||||||
* Export an app definition
|
* Export an app definition
|
||||||
*
|
*
|
||||||
* This will return a zip file containing the app definition model and all related models (process definitions and forms).
|
* This will return a zip file containing the app definition model and all related models (process definitions and forms).
|
||||||
*
|
|
||||||
* @param modelId modelId from a runtime app or the id of an app definition model
|
* @param modelId modelId from a runtime app or the id of an app definition model
|
||||||
* @return Promise<{}>
|
* @return Promise<{}>
|
||||||
*/
|
*/
|
||||||
@ -75,7 +73,6 @@ export class AppDefinitionsApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get an app definition
|
* Get an app definition
|
||||||
*
|
|
||||||
* @param modelId Application definition ID
|
* @param modelId Application definition ID
|
||||||
* @return Promise<AppDefinitionRepresentation>
|
* @return Promise<AppDefinitionRepresentation>
|
||||||
*/
|
*/
|
||||||
@ -94,7 +91,6 @@ export class AppDefinitionsApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* importAndPublishApp
|
* importAndPublishApp
|
||||||
*
|
|
||||||
* @param file file
|
* @param file file
|
||||||
* @param opts options
|
* @param opts options
|
||||||
* @return Promise<AppDefinitionUpdateResultRepresentation>
|
* @return Promise<AppDefinitionUpdateResultRepresentation>
|
||||||
@ -124,7 +120,6 @@ export class AppDefinitionsApi extends BaseApi {
|
|||||||
* Allows a zip file to be uploaded containing an app definition and any number of included models.
|
* Allows a zip file to be uploaded containing an app definition and any number of included models.
|
||||||
* <p>This is useful to bootstrap an environment (for users or continuous integration).<p>
|
* <p>This is useful to bootstrap an environment (for users or continuous integration).<p>
|
||||||
* Before using any processes included in the import the app must be published and deployed.
|
* Before using any processes included in the import the app must be published and deployed.
|
||||||
*
|
|
||||||
* @param file file
|
* @param file file
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
* @param opts.renewIdmEntries Whether to renew user and group identifiers (default to false)
|
* @param opts.renewIdmEntries Whether to renew user and group identifiers (default to false)
|
||||||
@ -149,7 +144,6 @@ export class AppDefinitionsApi extends BaseApi {
|
|||||||
* Publish an app definition
|
* Publish an app definition
|
||||||
*
|
*
|
||||||
* Publishing an app definition makes it available for use. The application must not have any validation errors or an error will be returned.<p>Before an app definition can be used by other users, it must also be deployed for their use
|
* Publishing an app definition makes it available for use. The application must not have any validation errors or an error will be returned.<p>Before an app definition can be used by other users, it must also be deployed for their use
|
||||||
*
|
|
||||||
* @param modelId modelId
|
* @param modelId modelId
|
||||||
* @param publishModel publishModel
|
* @param publishModel publishModel
|
||||||
* @return Promise<AppDefinitionUpdateResultRepresentation>
|
* @return Promise<AppDefinitionUpdateResultRepresentation>
|
||||||
@ -171,7 +165,6 @@ export class AppDefinitionsApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Update an app definition
|
* Update an app definition
|
||||||
*
|
|
||||||
* @param modelId Application definition ID
|
* @param modelId Application definition ID
|
||||||
* @param updatedModel updatedModel |
|
* @param updatedModel updatedModel |
|
||||||
* @return Promise<AppDefinitionUpdateResultRepresentation>
|
* @return Promise<AppDefinitionUpdateResultRepresentation>
|
||||||
|
@ -27,7 +27,6 @@ import { throwIfNotDefined } from '../../../assert';
|
|||||||
export class ChecklistsApi extends BaseApi {
|
export class ChecklistsApi extends BaseApi {
|
||||||
/**
|
/**
|
||||||
* Create a task checklist
|
* Create a task checklist
|
||||||
*
|
|
||||||
* @param taskId taskId
|
* @param taskId taskId
|
||||||
* @param taskRepresentation taskRepresentation
|
* @param taskRepresentation taskRepresentation
|
||||||
* @return Promise<TaskRepresentation>
|
* @return Promise<TaskRepresentation>
|
||||||
@ -50,7 +49,6 @@ export class ChecklistsApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get checklist for a task
|
* Get checklist for a task
|
||||||
*
|
|
||||||
* @param taskId taskId
|
* @param taskId taskId
|
||||||
* @return Promise<ResultListDataRepresentationTaskRepresentation>
|
* @return Promise<ResultListDataRepresentationTaskRepresentation>
|
||||||
*/
|
*/
|
||||||
@ -70,7 +68,6 @@ export class ChecklistsApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Change the order of items on a checklist
|
* Change the order of items on a checklist
|
||||||
*
|
|
||||||
* @param taskId taskId
|
* @param taskId taskId
|
||||||
* @param orderRepresentation orderRepresentation
|
* @param orderRepresentation orderRepresentation
|
||||||
* @return Promise<{}>
|
* @return Promise<{}>
|
||||||
|
@ -26,7 +26,6 @@ import { throwIfNotDefined } from '../../../assert';
|
|||||||
export class ActivitiCommentsApi extends BaseApi {
|
export class ActivitiCommentsApi extends BaseApi {
|
||||||
/**
|
/**
|
||||||
* Add a comment to a process instance
|
* Add a comment to a process instance
|
||||||
*
|
|
||||||
* @param commentRequest commentRequest
|
* @param commentRequest commentRequest
|
||||||
* @param processInstanceId processInstanceId
|
* @param processInstanceId processInstanceId
|
||||||
* @return Promise<CommentRepresentation>
|
* @return Promise<CommentRepresentation>
|
||||||
@ -49,7 +48,6 @@ export class ActivitiCommentsApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Add a comment to a task
|
* Add a comment to a task
|
||||||
*
|
|
||||||
* @param commentRequest commentRequest
|
* @param commentRequest commentRequest
|
||||||
* @param taskId taskId
|
* @param taskId taskId
|
||||||
* @return Promise<CommentRepresentation>
|
* @return Promise<CommentRepresentation>
|
||||||
@ -72,7 +70,6 @@ export class ActivitiCommentsApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get comments for a process
|
* Get comments for a process
|
||||||
*
|
|
||||||
* @param processInstanceId processInstanceId
|
* @param processInstanceId processInstanceId
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
* @return Promise<ResultListDataRepresentationCommentRepresentation>
|
* @return Promise<ResultListDataRepresentationCommentRepresentation>
|
||||||
@ -97,7 +94,6 @@ export class ActivitiCommentsApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get comments for a task
|
* Get comments for a task
|
||||||
*
|
|
||||||
* @param taskId taskId
|
* @param taskId taskId
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
* @return Promise<ResultListDataRepresentationCommentRepresentation>
|
* @return Promise<ResultListDataRepresentationCommentRepresentation>
|
||||||
|
@ -29,7 +29,6 @@ import { throwIfNotDefined } from '../../../assert';
|
|||||||
export class ContentApi extends BaseApi {
|
export class ContentApi extends BaseApi {
|
||||||
/**
|
/**
|
||||||
* Attach existing content to a process instance
|
* Attach existing content to a process instance
|
||||||
*
|
|
||||||
* @param processInstanceId processInstanceId
|
* @param processInstanceId processInstanceId
|
||||||
* @param relatedContent relatedContent
|
* @param relatedContent relatedContent
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
@ -75,7 +74,6 @@ export class ContentApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Attach existing content to a task
|
* Attach existing content to a task
|
||||||
*
|
|
||||||
* @param taskId taskId
|
* @param taskId taskId
|
||||||
* @param relatedContent relatedContent
|
* @param relatedContent relatedContent
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
@ -119,7 +117,6 @@ export class ContentApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Upload content and create a local representation
|
* Upload content and create a local representation
|
||||||
*
|
|
||||||
* @param file file
|
* @param file file
|
||||||
* @return Promise<RelatedContentRepresentation>
|
* @return Promise<RelatedContentRepresentation>
|
||||||
*/
|
*/
|
||||||
@ -140,7 +137,6 @@ export class ContentApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Create a local representation of content from a remote repository
|
* Create a local representation of content from a remote repository
|
||||||
*
|
|
||||||
* @param relatedContent relatedContent
|
* @param relatedContent relatedContent
|
||||||
* @return Promise<RelatedContentRepresentation>
|
* @return Promise<RelatedContentRepresentation>
|
||||||
*/
|
*/
|
||||||
@ -156,7 +152,6 @@ export class ContentApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Remove a local content representation
|
* Remove a local content representation
|
||||||
*
|
|
||||||
* @param contentId contentId
|
* @param contentId contentId
|
||||||
* @return Promise<{}>
|
* @return Promise<{}>
|
||||||
*/
|
*/
|
||||||
@ -175,7 +170,6 @@ export class ContentApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get a local content representation
|
* Get a local content representation
|
||||||
*
|
|
||||||
* @param contentId contentId
|
* @param contentId contentId
|
||||||
* @return Promise<RelatedContentRepresentation>
|
* @return Promise<RelatedContentRepresentation>
|
||||||
*/
|
*/
|
||||||
@ -195,7 +189,6 @@ export class ContentApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get content Raw URL for the given contentId
|
* Get content Raw URL for the given contentId
|
||||||
*
|
|
||||||
* @param contentId contentId
|
* @param contentId contentId
|
||||||
*/
|
*/
|
||||||
getRawContentUrl(contentId: number): string {
|
getRawContentUrl(contentId: number): string {
|
||||||
@ -204,7 +197,6 @@ export class ContentApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Stream content rendition
|
* Stream content rendition
|
||||||
*
|
|
||||||
* @param contentId contentId
|
* @param contentId contentId
|
||||||
* @param renditionType renditionType
|
* @param renditionType renditionType
|
||||||
* @return Promise<{}>
|
* @return Promise<{}>
|
||||||
@ -240,7 +232,6 @@ export class ContentApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* List content attached to a process instance
|
* List content attached to a process instance
|
||||||
*
|
|
||||||
* @param processInstanceId processInstanceId
|
* @param processInstanceId processInstanceId
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
* @return Promise<ResultListDataRepresentationRelatedContentRepresentation>
|
* @return Promise<ResultListDataRepresentationRelatedContentRepresentation>
|
||||||
@ -267,7 +258,6 @@ export class ContentApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* List content attached to a task
|
* List content attached to a task
|
||||||
*
|
|
||||||
* @param taskId taskId
|
* @param taskId taskId
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
* @return Promise<ResultListDataRepresentationRelatedContentRepresentation>
|
* @return Promise<ResultListDataRepresentationRelatedContentRepresentation>
|
||||||
@ -292,7 +282,6 @@ export class ContentApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Lists processes and tasks on workflow started with provided document
|
* Lists processes and tasks on workflow started with provided document
|
||||||
*
|
|
||||||
* @param sourceId - id of the document that workflow or task has been started with
|
* @param sourceId - id of the document that workflow or task has been started with
|
||||||
* @param source - source of the document that workflow or task has been started with
|
* @param source - source of the document that workflow or task has been started with
|
||||||
* @param size - size of the entries to get
|
* @param size - size of the entries to get
|
||||||
|
@ -24,7 +24,6 @@ import { BaseApi } from './base.api';
|
|||||||
export class DataSourcesApi extends BaseApi {
|
export class DataSourcesApi extends BaseApi {
|
||||||
/**
|
/**
|
||||||
* Get data sources
|
* Get data sources
|
||||||
*
|
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
* @return Promise<ResultListDataRepresentationDataSourceRepresentation>
|
* @return Promise<ResultListDataRepresentationDataSourceRepresentation>
|
||||||
*/
|
*/
|
||||||
|
@ -26,7 +26,6 @@ import { throwIfNotDefined } from '../../../assert';
|
|||||||
export class DecisionAuditsApi extends BaseApi {
|
export class DecisionAuditsApi extends BaseApi {
|
||||||
/**
|
/**
|
||||||
* Get an audit trail
|
* Get an audit trail
|
||||||
*
|
|
||||||
* @param auditTrailId auditTrailId
|
* @param auditTrailId auditTrailId
|
||||||
* @return Promise<DecisionAuditRepresentation>
|
* @return Promise<DecisionAuditRepresentation>
|
||||||
*/
|
*/
|
||||||
@ -46,7 +45,6 @@ export class DecisionAuditsApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Query decision table audit trails
|
* Query decision table audit trails
|
||||||
*
|
|
||||||
* @param decisionKey decisionKey
|
* @param decisionKey decisionKey
|
||||||
* @param dmnDeploymentId dmnDeploymentId
|
* @param dmnDeploymentId dmnDeploymentId
|
||||||
* @return Promise<ResultListDataRepresentationDecisionAuditRepresentation>
|
* @return Promise<ResultListDataRepresentationDecisionAuditRepresentation>
|
||||||
|
@ -36,7 +36,6 @@ export interface GetDecisionTablesOpts {
|
|||||||
export class DecisionTablesApi extends BaseApi {
|
export class DecisionTablesApi extends BaseApi {
|
||||||
/**
|
/**
|
||||||
* Get definition for a decision table
|
* Get definition for a decision table
|
||||||
*
|
|
||||||
* @param decisionTableId decisionTableId
|
* @param decisionTableId decisionTableId
|
||||||
* @return Promise<JsonNode>
|
* @return Promise<JsonNode>
|
||||||
*/
|
*/
|
||||||
@ -55,7 +54,6 @@ export class DecisionTablesApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get a decision table
|
* Get a decision table
|
||||||
*
|
|
||||||
* @param decisionTableId decisionTableId
|
* @param decisionTableId decisionTableId
|
||||||
* @return Promise<RuntimeDecisionTableRepresentation>
|
* @return Promise<RuntimeDecisionTableRepresentation>
|
||||||
*/
|
*/
|
||||||
@ -74,7 +72,6 @@ export class DecisionTablesApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Query decision tables
|
* Query decision tables
|
||||||
*
|
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
* @return Promise<ResultListDataRepresentationRuntimeDecisionTableRepresentation>
|
* @return Promise<ResultListDataRepresentationRuntimeDecisionTableRepresentation>
|
||||||
*/
|
*/
|
||||||
|
@ -25,7 +25,6 @@ import { throwIfNotDefined } from '../../../assert';
|
|||||||
export class EndpointsApi extends BaseApi {
|
export class EndpointsApi extends BaseApi {
|
||||||
/**
|
/**
|
||||||
* Get an endpoint configuration
|
* Get an endpoint configuration
|
||||||
*
|
|
||||||
* @param endpointConfigurationId endpointConfigurationId
|
* @param endpointConfigurationId endpointConfigurationId
|
||||||
* @return Promise<EndpointConfigurationRepresentation>
|
* @return Promise<EndpointConfigurationRepresentation>
|
||||||
*/
|
*/
|
||||||
@ -44,7 +43,6 @@ export class EndpointsApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* List endpoint configurations
|
* List endpoint configurations
|
||||||
*
|
|
||||||
* @return Promise<EndpointConfigurationRepresentation>
|
* @return Promise<EndpointConfigurationRepresentation>
|
||||||
*/
|
*/
|
||||||
getEndpointConfigurations(): Promise<EndpointConfigurationRepresentation> {
|
getEndpointConfigurations(): Promise<EndpointConfigurationRepresentation> {
|
||||||
|
@ -43,7 +43,6 @@ export interface GetFormsOpts {
|
|||||||
export class FormModelsApi extends BaseApi {
|
export class FormModelsApi extends BaseApi {
|
||||||
/**
|
/**
|
||||||
* Get form content
|
* Get form content
|
||||||
*
|
|
||||||
* @param formId formId
|
* @param formId formId
|
||||||
* @return Promise<FormDefinitionRepresentation>
|
* @return Promise<FormDefinitionRepresentation>
|
||||||
*/
|
*/
|
||||||
@ -62,7 +61,6 @@ export class FormModelsApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get form history
|
* Get form history
|
||||||
*
|
|
||||||
* @param formId formId
|
* @param formId formId
|
||||||
* @param formHistoryId formHistoryId
|
* @param formHistoryId formHistoryId
|
||||||
* @return Promise<FormRepresentation>
|
* @return Promise<FormRepresentation>
|
||||||
@ -85,7 +83,6 @@ export class FormModelsApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get a form model
|
* Get a form model
|
||||||
*
|
|
||||||
* @param formId {number} formId
|
* @param formId {number} formId
|
||||||
* @return Promise<FormRepresentation>
|
* @return Promise<FormRepresentation>
|
||||||
*/
|
*/
|
||||||
@ -105,7 +102,6 @@ export class FormModelsApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get forms
|
* Get forms
|
||||||
*
|
|
||||||
* @param input input
|
* @param input input
|
||||||
* @return Promise<FormRepresentation>
|
* @return Promise<FormRepresentation>
|
||||||
*/
|
*/
|
||||||
@ -137,7 +133,6 @@ export class FormModelsApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Update form model content
|
* Update form model content
|
||||||
*
|
|
||||||
* @param formId ID of the form to update
|
* @param formId ID of the form to update
|
||||||
* @param saveRepresentation saveRepresentation
|
* @param saveRepresentation saveRepresentation
|
||||||
* @return Promise<FormRepresentation>
|
* @return Promise<FormRepresentation>
|
||||||
@ -162,7 +157,6 @@ export class FormModelsApi extends BaseApi {
|
|||||||
* Validate form model content
|
* Validate form model content
|
||||||
*
|
*
|
||||||
* The model content to be validated must be specified in the POST body
|
* The model content to be validated must be specified in the POST body
|
||||||
*
|
|
||||||
* @param formId formId
|
* @param formId formId
|
||||||
* @param saveRepresentation saveRepresentation
|
* @param saveRepresentation saveRepresentation
|
||||||
* @return Promise<ValidationErrorRepresentation>
|
* @return Promise<ValidationErrorRepresentation>
|
||||||
|
@ -33,7 +33,6 @@ export interface GetGroupsOpts {
|
|||||||
export class ActivitiGroupsApi extends BaseApi {
|
export class ActivitiGroupsApi extends BaseApi {
|
||||||
/**
|
/**
|
||||||
* Query groups
|
* Query groups
|
||||||
*
|
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
* @return Promise<ResultListDataRepresentationLightGroupRepresentation>
|
* @return Promise<ResultListDataRepresentationLightGroupRepresentation>
|
||||||
*/
|
*/
|
||||||
@ -46,7 +45,6 @@ export class ActivitiGroupsApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* List members of a group
|
* List members of a group
|
||||||
*
|
|
||||||
* @param groupId groupId
|
* @param groupId groupId
|
||||||
* @return Promise<ResultListDataRepresentationLightUserRepresentation>
|
* @return Promise<ResultListDataRepresentationLightUserRepresentation>
|
||||||
*/
|
*/
|
||||||
|
@ -25,7 +25,6 @@ import { throwIfNotDefined } from '../../../assert';
|
|||||||
export class IDMSyncApi extends BaseApi {
|
export class IDMSyncApi extends BaseApi {
|
||||||
/**
|
/**
|
||||||
* Get log file for a sync log entry
|
* Get log file for a sync log entry
|
||||||
*
|
|
||||||
* @param syncLogEntryId syncLogEntryId
|
* @param syncLogEntryId syncLogEntryId
|
||||||
* @return Promise<{}>
|
* @return Promise<{}>
|
||||||
*/
|
*/
|
||||||
@ -44,7 +43,6 @@ export class IDMSyncApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* List sync log entries
|
* List sync log entries
|
||||||
*
|
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
* @param opts.tenantId {number} tenantId
|
* @param opts.tenantId {number} tenantId
|
||||||
* @param opts.page {number} page
|
* @param opts.page {number} page
|
||||||
|
@ -30,7 +30,6 @@ export class IntegrationAlfrescoCloudApi extends BaseApi {
|
|||||||
/**
|
/**
|
||||||
* Alfresco Cloud Authorization
|
* Alfresco Cloud Authorization
|
||||||
* Returns Alfresco OAuth HTML Page
|
* Returns Alfresco OAuth HTML Page
|
||||||
*
|
|
||||||
* @param code code
|
* @param code code
|
||||||
* @return Promise<{}>
|
* @return Promise<{}>
|
||||||
*/
|
*/
|
||||||
@ -50,7 +49,6 @@ export class IntegrationAlfrescoCloudApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* List Alfresco networks
|
* List Alfresco networks
|
||||||
*
|
|
||||||
* @return Promise<ResultListDataRepresentationAlfrescoNetworkRepresenation>
|
* @return Promise<ResultListDataRepresentationAlfrescoNetworkRepresenation>
|
||||||
*/
|
*/
|
||||||
getAllNetworks(): Promise<ResultListDataRepresentationAlfrescoNetworkRepresenation> {
|
getAllNetworks(): Promise<ResultListDataRepresentationAlfrescoNetworkRepresenation> {
|
||||||
@ -62,7 +60,6 @@ export class IntegrationAlfrescoCloudApi extends BaseApi {
|
|||||||
/**
|
/**
|
||||||
* List Alfresco sites
|
* List Alfresco sites
|
||||||
* Returns ALL Sites
|
* Returns ALL Sites
|
||||||
*
|
|
||||||
* @param networkId networkId
|
* @param networkId networkId
|
||||||
* @return Promise<ResultListDataRepresentationAlfrescoSiteRepresenation>
|
* @return Promise<ResultListDataRepresentationAlfrescoSiteRepresenation>
|
||||||
*/
|
*/
|
||||||
@ -81,7 +78,6 @@ export class IntegrationAlfrescoCloudApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* List files and folders inside a specific folder identified by path
|
* List files and folders inside a specific folder identified by path
|
||||||
*
|
|
||||||
* @param networkId networkId
|
* @param networkId networkId
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
* @param opts.siteId {string} siteId
|
* @param opts.siteId {string} siteId
|
||||||
@ -107,7 +103,6 @@ export class IntegrationAlfrescoCloudApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* List files and folders inside a specific folder
|
* List files and folders inside a specific folder
|
||||||
*
|
|
||||||
* @param networkId networkId
|
* @param networkId networkId
|
||||||
* @param folderId folderId
|
* @param folderId folderId
|
||||||
* @return Promise<ResultListDataRepresentationAlfrescoContentRepresentation>
|
* @return Promise<ResultListDataRepresentationAlfrescoContentRepresentation>
|
||||||
@ -129,7 +124,6 @@ export class IntegrationAlfrescoCloudApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* List files and folders inside a specific site
|
* List files and folders inside a specific site
|
||||||
*
|
|
||||||
* @param networkId networkId
|
* @param networkId networkId
|
||||||
* @param siteId siteId
|
* @param siteId siteId
|
||||||
* @return Promise<ResultListDataRepresentationAlfrescoContentRepresentation>
|
* @return Promise<ResultListDataRepresentationAlfrescoContentRepresentation>
|
||||||
|
@ -30,7 +30,6 @@ export class IntegrationAlfrescoOnPremiseApi extends BaseApi {
|
|||||||
/**
|
/**
|
||||||
* List Alfresco sites
|
* List Alfresco sites
|
||||||
* Returns ALL Sites
|
* Returns ALL Sites
|
||||||
*
|
|
||||||
* @param repositoryId repositoryId
|
* @param repositoryId repositoryId
|
||||||
* @return Promise<ResultListDataRepresentationAlfrescoSiteRepresenation>
|
* @return Promise<ResultListDataRepresentationAlfrescoSiteRepresenation>
|
||||||
*/
|
*/
|
||||||
@ -49,7 +48,6 @@ export class IntegrationAlfrescoOnPremiseApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* List files and folders inside a specific folder identified by folder path
|
* List files and folders inside a specific folder identified by folder path
|
||||||
*
|
|
||||||
* @param repositoryId repositoryId
|
* @param repositoryId repositoryId
|
||||||
* @param siteId siteId
|
* @param siteId siteId
|
||||||
* @param folderPath folderPath
|
* @param folderPath folderPath
|
||||||
@ -78,7 +76,6 @@ export class IntegrationAlfrescoOnPremiseApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* List files and folders inside a specific folder
|
* List files and folders inside a specific folder
|
||||||
*
|
|
||||||
* @param repositoryId repositoryId
|
* @param repositoryId repositoryId
|
||||||
* @param folderId folderId
|
* @param folderId folderId
|
||||||
* @return Promise<ResultListDataRepresentationAlfrescoContentRepresentation>
|
* @return Promise<ResultListDataRepresentationAlfrescoContentRepresentation>
|
||||||
@ -100,7 +97,6 @@ export class IntegrationAlfrescoOnPremiseApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* List files and folders inside a specific site
|
* List files and folders inside a specific site
|
||||||
*
|
|
||||||
* @param repositoryId repositoryId
|
* @param repositoryId repositoryId
|
||||||
* @param siteId siteId
|
* @param siteId siteId
|
||||||
* @return Promise<ResultListDataRepresentationAlfrescoContentRepresentation>
|
* @return Promise<ResultListDataRepresentationAlfrescoContentRepresentation>
|
||||||
@ -124,7 +120,6 @@ export class IntegrationAlfrescoOnPremiseApi extends BaseApi {
|
|||||||
* List Alfresco repositories
|
* List Alfresco repositories
|
||||||
*
|
*
|
||||||
* A tenant administrator can configure one or more Alfresco repositories to use when working with content.
|
* A tenant administrator can configure one or more Alfresco repositories to use when working with content.
|
||||||
*
|
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
* @param opts.tenantId {string} tenantId
|
* @param opts.tenantId {string} tenantId
|
||||||
* @param opts.includeAccounts {boolean} includeAccounts (default to true)
|
* @param opts.includeAccounts {boolean} includeAccounts (default to true)
|
||||||
|
@ -26,7 +26,6 @@ export class IntegrationBoxApi extends BaseApi {
|
|||||||
/**
|
/**
|
||||||
* Box Authorization
|
* Box Authorization
|
||||||
* Returns Box OAuth HTML Page
|
* Returns Box OAuth HTML Page
|
||||||
*
|
|
||||||
* @return Promise<{}>
|
* @return Promise<{}>
|
||||||
*/
|
*/
|
||||||
confirmAuthorisation(): Promise<any> {
|
confirmAuthorisation(): Promise<any> {
|
||||||
@ -38,7 +37,6 @@ export class IntegrationBoxApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Add Box account
|
* Add Box account
|
||||||
*
|
|
||||||
* @param userId userId
|
* @param userId userId
|
||||||
* @param credentials credentials
|
* @param credentials credentials
|
||||||
* @return Promise<{}>
|
* @return Promise<{}>
|
||||||
@ -60,7 +58,6 @@ export class IntegrationBoxApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Delete account information
|
* Delete account information
|
||||||
*
|
|
||||||
* @param userId userId
|
* @param userId userId
|
||||||
* @return Promise<{}>
|
* @return Promise<{}>
|
||||||
*/
|
*/
|
||||||
@ -82,7 +79,6 @@ export class IntegrationBoxApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get status information
|
* Get status information
|
||||||
*
|
|
||||||
* @return Promise<boolean>
|
* @return Promise<boolean>
|
||||||
*/
|
*/
|
||||||
getBoxPluginStatus(): Promise<boolean> {
|
getBoxPluginStatus(): Promise<boolean> {
|
||||||
@ -94,7 +90,6 @@ export class IntegrationBoxApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* List file and folders
|
* List file and folders
|
||||||
*
|
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
* @param opts.filter filter
|
* @param opts.filter filter
|
||||||
* @param opts.parent parent
|
* @param opts.parent parent
|
||||||
@ -112,7 +107,6 @@ export class IntegrationBoxApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get account information
|
* Get account information
|
||||||
*
|
|
||||||
* @param userId userId
|
* @param userId userId
|
||||||
* @return Promise<{}>
|
* @return Promise<{}>
|
||||||
*/
|
*/
|
||||||
@ -132,7 +126,6 @@ export class IntegrationBoxApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Update account information
|
* Update account information
|
||||||
*
|
|
||||||
* @param userId userId
|
* @param userId userId
|
||||||
* @param credentials credentials
|
* @param credentials credentials
|
||||||
* @return Promise<{}>
|
* @return Promise<{}>
|
||||||
|
@ -25,7 +25,6 @@ export class IntegrationDriveApi extends BaseApi {
|
|||||||
/**
|
/**
|
||||||
* Drive Authorization
|
* Drive Authorization
|
||||||
* Returns Drive OAuth HTML Page
|
* Returns Drive OAuth HTML Page
|
||||||
*
|
|
||||||
* @return Promise<{}>
|
* @return Promise<{}>
|
||||||
*/
|
*/
|
||||||
confirmAuthorisation(): Promise<any> {
|
confirmAuthorisation(): Promise<any> {
|
||||||
@ -37,7 +36,6 @@ export class IntegrationDriveApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* List files and folders
|
* List files and folders
|
||||||
*
|
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
* @param opts.filter {string} filter
|
* @param opts.filter {string} filter
|
||||||
* @param opts.parent {string} parent
|
* @param opts.parent {string} parent
|
||||||
|
@ -21,7 +21,6 @@ import { throwIfNotDefined } from '../../../assert';
|
|||||||
export class ModelJsonBpmnApi extends BaseApi {
|
export class ModelJsonBpmnApi extends BaseApi {
|
||||||
/**
|
/**
|
||||||
* Export a previous process definition model to a JSON
|
* Export a previous process definition model to a JSON
|
||||||
*
|
|
||||||
* @param processModelId processModelId
|
* @param processModelId processModelId
|
||||||
* @param processModelHistoryId processModelHistoryId
|
* @param processModelHistoryId processModelHistoryId
|
||||||
*/
|
*/
|
||||||
@ -42,7 +41,6 @@ export class ModelJsonBpmnApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Export a process definition model to a JSON
|
* Export a process definition model to a JSON
|
||||||
*
|
|
||||||
* @param processModelId processModelId
|
* @param processModelId processModelId
|
||||||
*/
|
*/
|
||||||
getEditorDisplayJsonClient(processModelId: number) {
|
getEditorDisplayJsonClient(processModelId: number) {
|
||||||
@ -60,7 +58,6 @@ export class ModelJsonBpmnApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Function to receive the result of the getModelJSONForProcessDefinition operation.
|
* Function to receive the result of the getModelJSONForProcessDefinition operation.
|
||||||
*
|
|
||||||
* @param processDefinitionId processDefinitionId
|
* @param processDefinitionId processDefinitionId
|
||||||
*/
|
*/
|
||||||
getModelJSON(processDefinitionId: string) {
|
getModelJSON(processDefinitionId: string) {
|
||||||
@ -78,7 +75,6 @@ export class ModelJsonBpmnApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Function to receive the result of the getModelHistoryJSON operation.
|
* Function to receive the result of the getModelHistoryJSON operation.
|
||||||
*
|
|
||||||
* @param processInstanceId processInstanceId
|
* @param processInstanceId processInstanceId
|
||||||
*/
|
*/
|
||||||
getModelJSONForProcessDefinition(processInstanceId: string) {
|
getModelJSONForProcessDefinition(processInstanceId: string) {
|
||||||
|
@ -32,7 +32,6 @@ export interface GetModelsQuery {
|
|||||||
export class ModelsApi extends BaseApi {
|
export class ModelsApi extends BaseApi {
|
||||||
/**
|
/**
|
||||||
* Create a new model
|
* Create a new model
|
||||||
*
|
|
||||||
* @param modelRepresentation modelRepresentation
|
* @param modelRepresentation modelRepresentation
|
||||||
* @return Promise<ModelRepresentation>
|
* @return Promise<ModelRepresentation>
|
||||||
*/
|
*/
|
||||||
@ -48,7 +47,6 @@ export class ModelsApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Delete a model
|
* Delete a model
|
||||||
*
|
|
||||||
* @param modelId modelId
|
* @param modelId modelId
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
* @param opts.cascade cascade
|
* @param opts.cascade cascade
|
||||||
@ -76,7 +74,6 @@ export class ModelsApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Duplicate an existing model
|
* Duplicate an existing model
|
||||||
*
|
|
||||||
* @param modelId modelId
|
* @param modelId modelId
|
||||||
* @param modelRepresentation modelRepresentation
|
* @param modelRepresentation modelRepresentation
|
||||||
* @return Promise<ModelRepresentation>
|
* @return Promise<ModelRepresentation>
|
||||||
@ -99,7 +96,6 @@ export class ModelsApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get model content
|
* Get model content
|
||||||
*
|
|
||||||
* @param modelId modelId
|
* @param modelId modelId
|
||||||
* @return Promise<ObjectNode>
|
* @return Promise<ObjectNode>
|
||||||
*/
|
*/
|
||||||
@ -118,7 +114,6 @@ export class ModelsApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get a model's thumbnail image
|
* Get a model's thumbnail image
|
||||||
*
|
|
||||||
* @param modelId modelId
|
* @param modelId modelId
|
||||||
* @return Promise<string>
|
* @return Promise<string>
|
||||||
*/
|
*/
|
||||||
@ -140,7 +135,6 @@ export class ModelsApi extends BaseApi {
|
|||||||
* Get a model
|
* Get a model
|
||||||
*
|
*
|
||||||
* Models act as containers for process, form, decision table and app definitions
|
* Models act as containers for process, form, decision table and app definitions
|
||||||
*
|
|
||||||
* @param modelId modelId
|
* @param modelId modelId
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
* @return Promise<ModelRepresentation>
|
* @return Promise<ModelRepresentation>
|
||||||
@ -166,7 +160,6 @@ export class ModelsApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* List process definition models shared with the current user
|
* List process definition models shared with the current user
|
||||||
*
|
|
||||||
* @return Promise<ResultListDataRepresentationModelRepresentation>
|
* @return Promise<ResultListDataRepresentationModelRepresentation>
|
||||||
*/
|
*/
|
||||||
getModelsToIncludeInAppDefinition(): Promise<ResultListDataRepresentationModelRepresentation> {
|
getModelsToIncludeInAppDefinition(): Promise<ResultListDataRepresentationModelRepresentation> {
|
||||||
@ -178,7 +171,6 @@ export class ModelsApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* List models (process, form, decision rule or app)
|
* List models (process, form, decision rule or app)
|
||||||
*
|
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
* @return Promise<ResultListDataRepresentationModelRepresentation>
|
* @return Promise<ResultListDataRepresentationModelRepresentation>
|
||||||
*/
|
*/
|
||||||
@ -192,7 +184,6 @@ export class ModelsApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Create a new version of a model
|
* Create a new version of a model
|
||||||
*
|
|
||||||
* @param modelId modelId
|
* @param modelId modelId
|
||||||
* @param file file
|
* @param file file
|
||||||
* @return Promise<ModelRepresentation>
|
* @return Promise<ModelRepresentation>
|
||||||
@ -220,7 +211,6 @@ export class ModelsApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Import a BPMN 2.0 XML file
|
* Import a BPMN 2.0 XML file
|
||||||
*
|
|
||||||
* @param file file
|
* @param file file
|
||||||
* @return Promise<ModelRepresentation>
|
* @return Promise<ModelRepresentation>
|
||||||
*/
|
*/
|
||||||
@ -241,7 +231,6 @@ export class ModelsApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Update model content
|
* Update model content
|
||||||
*
|
|
||||||
* @param modelId modelId
|
* @param modelId modelId
|
||||||
* @param values values
|
* @param values values
|
||||||
* @return Promise<ModelRepresentation>
|
* @return Promise<ModelRepresentation>
|
||||||
@ -266,7 +255,6 @@ export class ModelsApi extends BaseApi {
|
|||||||
* Update a model
|
* Update a model
|
||||||
*
|
*
|
||||||
* This method allows you to update the metadata of a model. In order to update the content of the model you will need to call the specific endpoint for that model type.
|
* This method allows you to update the metadata of a model. In order to update the content of the model you will need to call the specific endpoint for that model type.
|
||||||
*
|
|
||||||
* @param modelId modelId
|
* @param modelId modelId
|
||||||
* @param updatedModel updatedModel
|
* @param updatedModel updatedModel
|
||||||
* @return Promise<ModelRepresentation>
|
* @return Promise<ModelRepresentation>
|
||||||
@ -289,7 +277,6 @@ export class ModelsApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Validate model content
|
* Validate model content
|
||||||
*
|
|
||||||
* @param modelId modelId
|
* @param modelId modelId
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
* @param opts.values values
|
* @param opts.values values
|
||||||
|
@ -24,7 +24,6 @@ import { throwIfNotDefined } from '../../../assert';
|
|||||||
export class ModelsBpmnApi extends BaseApi {
|
export class ModelsBpmnApi extends BaseApi {
|
||||||
/**
|
/**
|
||||||
* Export a historic version of a process definition as BPMN 2.0 XML
|
* Export a historic version of a process definition as BPMN 2.0 XML
|
||||||
*
|
|
||||||
* @param processModelId processModelId
|
* @param processModelId processModelId
|
||||||
* @param processModelHistoryId processModelHistoryId
|
* @param processModelHistoryId processModelHistoryId
|
||||||
* @return Promise<{}>
|
* @return Promise<{}>
|
||||||
@ -49,7 +48,6 @@ export class ModelsBpmnApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Export a process definition as BPMN 2.0 XML
|
* Export a process definition as BPMN 2.0 XML
|
||||||
*
|
|
||||||
* @param processModelId processModelId
|
* @param processModelId processModelId
|
||||||
* @return Promise<{}>
|
* @return Promise<{}>
|
||||||
*/
|
*/
|
||||||
|
@ -26,7 +26,6 @@ import { throwIfNotDefined } from '../../../assert';
|
|||||||
export class ModelsHistoryApi extends BaseApi {
|
export class ModelsHistoryApi extends BaseApi {
|
||||||
/**
|
/**
|
||||||
* List a model's historic versions
|
* List a model's historic versions
|
||||||
*
|
|
||||||
* @param modelId modelId
|
* @param modelId modelId
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
* @param opts.includeLatestVersion includeLatestVersion
|
* @param opts.includeLatestVersion includeLatestVersion
|
||||||
@ -53,7 +52,6 @@ export class ModelsHistoryApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get a historic version of a model
|
* Get a historic version of a model
|
||||||
*
|
|
||||||
* @param modelId modelId
|
* @param modelId modelId
|
||||||
* @param modelHistoryId modelHistoryId
|
* @param modelHistoryId modelHistoryId
|
||||||
* @return Promise<ModelRepresentation>
|
* @return Promise<ModelRepresentation>
|
||||||
|
@ -32,7 +32,6 @@ import { throwIfNotDefined } from '../../../assert';
|
|||||||
export class ProcessDefinitionsApi extends BaseApi {
|
export class ProcessDefinitionsApi extends BaseApi {
|
||||||
/**
|
/**
|
||||||
* Add a user or group involvement to a process definition
|
* Add a user or group involvement to a process definition
|
||||||
*
|
|
||||||
* @param processDefinitionId processDefinitionId
|
* @param processDefinitionId processDefinitionId
|
||||||
* @param identityLinkRepresentation identityLinkRepresentation
|
* @param identityLinkRepresentation identityLinkRepresentation
|
||||||
* @return Promise<IdentityLinkRepresentation>
|
* @return Promise<IdentityLinkRepresentation>
|
||||||
@ -54,7 +53,6 @@ export class ProcessDefinitionsApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Remove a user or group involvement from a process definition
|
* Remove a user or group involvement from a process definition
|
||||||
*
|
|
||||||
* @param processDefinitionId Process definition ID
|
* @param processDefinitionId Process definition ID
|
||||||
* @param family Identity type
|
* @param family Identity type
|
||||||
* @param identityId User or group ID
|
* @param identityId User or group ID
|
||||||
@ -79,7 +77,6 @@ export class ProcessDefinitionsApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get a user or group involvement with a process definition
|
* Get a user or group involvement with a process definition
|
||||||
*
|
|
||||||
* @param processDefinitionId Process definition ID
|
* @param processDefinitionId Process definition ID
|
||||||
* @param family Identity type
|
* @param family Identity type
|
||||||
* @param identityId User or group ID
|
* @param identityId User or group ID
|
||||||
@ -104,7 +101,6 @@ export class ProcessDefinitionsApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* List either the users or groups involved with a process definition
|
* List either the users or groups involved with a process definition
|
||||||
*
|
|
||||||
* @param processDefinitionId processDefinitionId
|
* @param processDefinitionId processDefinitionId
|
||||||
* @param family Identity type
|
* @param family Identity type
|
||||||
* @return Promise<IdentityLinkRepresentation>
|
* @return Promise<IdentityLinkRepresentation>
|
||||||
@ -126,7 +122,6 @@ export class ProcessDefinitionsApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* List the users and groups involved with a process definition
|
* List the users and groups involved with a process definition
|
||||||
*
|
|
||||||
* @param processDefinitionId processDefinitionId
|
* @param processDefinitionId processDefinitionId
|
||||||
* @return Promise<IdentityLinkRepresentation>
|
* @return Promise<IdentityLinkRepresentation>
|
||||||
*/
|
*/
|
||||||
@ -145,7 +140,6 @@ export class ProcessDefinitionsApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* List the decision tables associated with a process definition
|
* List the decision tables associated with a process definition
|
||||||
*
|
|
||||||
* @param processDefinitionId processDefinitionId
|
* @param processDefinitionId processDefinitionId
|
||||||
* @return Promise<ResultListDataRepresentationRuntimeDecisionTableRepresentation>
|
* @return Promise<ResultListDataRepresentationRuntimeDecisionTableRepresentation>
|
||||||
*/
|
*/
|
||||||
@ -164,7 +158,6 @@ export class ProcessDefinitionsApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* List the forms associated with a process definition
|
* List the forms associated with a process definition
|
||||||
*
|
|
||||||
* @param processDefinitionId processDefinitionId
|
* @param processDefinitionId processDefinitionId
|
||||||
* @return Promise<ResultListDataRepresentationRuntimeFormRepresentation>
|
* @return Promise<ResultListDataRepresentationRuntimeFormRepresentation>
|
||||||
*/
|
*/
|
||||||
@ -183,7 +176,6 @@ export class ProcessDefinitionsApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Retrieve the start form for a process definition
|
* Retrieve the start form for a process definition
|
||||||
*
|
|
||||||
* @param processDefinitionId processDefinitionId
|
* @param processDefinitionId processDefinitionId
|
||||||
* @return Promise<FormDefinitionRepresentation>
|
* @return Promise<FormDefinitionRepresentation>
|
||||||
*/
|
*/
|
||||||
@ -202,7 +194,6 @@ export class ProcessDefinitionsApi extends BaseApi {
|
|||||||
* Retrieve a list of process definitions
|
* Retrieve a list of process definitions
|
||||||
*
|
*
|
||||||
* Get a list of process definitions (visible within the tenant of the user)
|
* Get a list of process definitions (visible within the tenant of the user)
|
||||||
*
|
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
* @return Promise<ResultListDataRepresentationProcessDefinitionRepresentation>
|
* @return Promise<ResultListDataRepresentationProcessDefinitionRepresentation>
|
||||||
*/
|
*/
|
||||||
@ -219,7 +210,6 @@ export class ProcessDefinitionsApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Retrieve field values (e.g. the typeahead field)
|
* Retrieve field values (e.g. the typeahead field)
|
||||||
*
|
|
||||||
* @param processDefinitionId processDefinitionId
|
* @param processDefinitionId processDefinitionId
|
||||||
* @param field field
|
* @param field field
|
||||||
* @return Promise<FormValueRepresentation[]>
|
* @return Promise<FormValueRepresentation[]>
|
||||||
@ -238,7 +228,6 @@ export class ProcessDefinitionsApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Retrieve field values (eg. the table field)
|
* Retrieve field values (eg. the table field)
|
||||||
*
|
|
||||||
* @param processDefinitionId processDefinitionId
|
* @param processDefinitionId processDefinitionId
|
||||||
* @param field field
|
* @param field field
|
||||||
* @param column column
|
* @param column column
|
||||||
|
@ -25,7 +25,6 @@ import { throwIfNotDefined } from '../../../assert';
|
|||||||
export class ProcessInstanceVariablesApi extends BaseApi {
|
export class ProcessInstanceVariablesApi extends BaseApi {
|
||||||
/**
|
/**
|
||||||
* Create or update variables
|
* Create or update variables
|
||||||
*
|
|
||||||
* @param processInstanceId Process instance ID
|
* @param processInstanceId Process instance ID
|
||||||
* @param restVariables restVariables
|
* @param restVariables restVariables
|
||||||
* @return Promise<RestVariable>
|
* @return Promise<RestVariable>
|
||||||
@ -47,7 +46,6 @@ export class ProcessInstanceVariablesApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Delete a variable
|
* Delete a variable
|
||||||
*
|
|
||||||
* @param processInstanceId processInstanceId
|
* @param processInstanceId processInstanceId
|
||||||
* @param variableName variableName
|
* @param variableName variableName
|
||||||
* @return Promise<{}>
|
* @return Promise<{}>
|
||||||
@ -69,7 +67,6 @@ export class ProcessInstanceVariablesApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get a variable
|
* Get a variable
|
||||||
*
|
|
||||||
* @param processInstanceId processInstanceId
|
* @param processInstanceId processInstanceId
|
||||||
* @param variableName variableName
|
* @param variableName variableName
|
||||||
* @return Promise<RestVariable>
|
* @return Promise<RestVariable>
|
||||||
@ -91,7 +88,6 @@ export class ProcessInstanceVariablesApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* List variables
|
* List variables
|
||||||
*
|
|
||||||
* @param processInstanceId Process instance ID
|
* @param processInstanceId Process instance ID
|
||||||
* @return Promise<RestVariable>
|
* @return Promise<RestVariable>
|
||||||
*/
|
*/
|
||||||
@ -110,7 +106,6 @@ export class ProcessInstanceVariablesApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Update a variable
|
* Update a variable
|
||||||
*
|
|
||||||
* @param processInstanceId processInstanceId
|
* @param processInstanceId processInstanceId
|
||||||
* @param variableName variableName
|
* @param variableName variableName
|
||||||
* @param restVariable restVariable
|
* @param restVariable restVariable
|
||||||
|
@ -38,7 +38,6 @@ import { throwIfNotDefined } from '../../../assert';
|
|||||||
export class ProcessInstancesApi extends BaseApi {
|
export class ProcessInstancesApi extends BaseApi {
|
||||||
/**
|
/**
|
||||||
* Activate a process instance
|
* Activate a process instance
|
||||||
*
|
|
||||||
* @param processInstanceId processInstanceId
|
* @param processInstanceId processInstanceId
|
||||||
* @return Promise<ProcessInstanceRepresentation>
|
* @return Promise<ProcessInstanceRepresentation>
|
||||||
*/
|
*/
|
||||||
@ -58,7 +57,6 @@ export class ProcessInstancesApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Add a user or group involvement to a process instance
|
* Add a user or group involvement to a process instance
|
||||||
*
|
|
||||||
* @param processInstanceId processInstanceId
|
* @param processInstanceId processInstanceId
|
||||||
* @param identityLinkRepresentation identityLinkRepresentation
|
* @param identityLinkRepresentation identityLinkRepresentation
|
||||||
* @return Promise<IdentityLinkRepresentation>
|
* @return Promise<IdentityLinkRepresentation>
|
||||||
@ -80,7 +78,6 @@ export class ProcessInstancesApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Remove a user or group involvement from a process instance
|
* Remove a user or group involvement from a process instance
|
||||||
*
|
|
||||||
* @param processInstanceId processInstanceId
|
* @param processInstanceId processInstanceId
|
||||||
* @param family family
|
* @param family family
|
||||||
* @param identityId identityId
|
* @param identityId identityId
|
||||||
@ -110,7 +107,6 @@ export class ProcessInstancesApi extends BaseApi {
|
|||||||
* Cancel or remove a process instance
|
* Cancel or remove a process instance
|
||||||
*
|
*
|
||||||
* If the process instance has not yet been completed, it will be cancelled. If it has already finished or been cancelled then the process instance will be removed and will no longer appear in queries.
|
* If the process instance has not yet been completed, it will be cancelled. If it has already finished or been cancelled then the process instance will be removed and will no longer appear in queries.
|
||||||
*
|
|
||||||
* @param processInstanceId processInstanceId
|
* @param processInstanceId processInstanceId
|
||||||
* @return Promise<{}>
|
* @return Promise<{}>
|
||||||
*/
|
*/
|
||||||
@ -131,7 +127,6 @@ export class ProcessInstancesApi extends BaseApi {
|
|||||||
* List process instances using a filter
|
* List process instances using a filter
|
||||||
*
|
*
|
||||||
* The request body provided must define either a valid filterId value or filter object
|
* The request body provided must define either a valid filterId value or filter object
|
||||||
*
|
|
||||||
* @param filterRequest filterRequest
|
* @param filterRequest filterRequest
|
||||||
* @return Promise<ResultListDataRepresentationProcessInstanceRepresentation>
|
* @return Promise<ResultListDataRepresentationProcessInstanceRepresentation>
|
||||||
*/
|
*/
|
||||||
@ -149,7 +144,6 @@ export class ProcessInstancesApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get decision tasks in a process instance
|
* Get decision tasks in a process instance
|
||||||
*
|
|
||||||
* @param processInstanceId processInstanceId
|
* @param processInstanceId processInstanceId
|
||||||
* @return Promise<ResultListDataRepresentationDecisionTaskRepresentation>
|
* @return Promise<ResultListDataRepresentationDecisionTaskRepresentation>
|
||||||
*/
|
*/
|
||||||
@ -169,7 +163,6 @@ export class ProcessInstancesApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get historic variables for a process instance
|
* Get historic variables for a process instance
|
||||||
*
|
|
||||||
* @param processInstanceId processInstanceId
|
* @param processInstanceId processInstanceId
|
||||||
* @return Promise<ProcessInstanceVariableRepresentation>
|
* @return Promise<ProcessInstanceVariableRepresentation>
|
||||||
*/
|
*/
|
||||||
@ -188,7 +181,6 @@ export class ProcessInstancesApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Query historic process instances
|
* Query historic process instances
|
||||||
*
|
|
||||||
* @param queryRequest queryRequest
|
* @param queryRequest queryRequest
|
||||||
* @return Promise<ResultListDataRepresentationProcessInstanceRepresentation>
|
* @return Promise<ResultListDataRepresentationProcessInstanceRepresentation>
|
||||||
*/
|
*/
|
||||||
@ -206,7 +198,6 @@ export class ProcessInstancesApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get a user or group involvement with a process instance
|
* Get a user or group involvement with a process instance
|
||||||
*
|
|
||||||
* @param processInstanceId processInstanceId
|
* @param processInstanceId processInstanceId
|
||||||
* @param family family
|
* @param family family
|
||||||
* @param identityId identityId
|
* @param identityId identityId
|
||||||
@ -234,7 +225,6 @@ export class ProcessInstancesApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* List either the users or groups involved with a process instance
|
* List either the users or groups involved with a process instance
|
||||||
*
|
|
||||||
* @param processInstanceId processInstanceId
|
* @param processInstanceId processInstanceId
|
||||||
* @param family family
|
* @param family family
|
||||||
* @return Promise<IdentityLinkRepresentation>
|
* @return Promise<IdentityLinkRepresentation>
|
||||||
@ -256,7 +246,6 @@ export class ProcessInstancesApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* List the users and groups involved with a process instance
|
* List the users and groups involved with a process instance
|
||||||
*
|
|
||||||
* @param processInstanceId processInstanceId
|
* @param processInstanceId processInstanceId
|
||||||
* @return Promise<IdentityLinkRepresentation>
|
* @return Promise<IdentityLinkRepresentation>
|
||||||
*/
|
*/
|
||||||
@ -275,7 +264,6 @@ export class ProcessInstancesApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* List content attached to process instance fields
|
* List content attached to process instance fields
|
||||||
*
|
|
||||||
* @param processInstanceId processInstanceId
|
* @param processInstanceId processInstanceId
|
||||||
* @return Promise<ResultListDataRepresentationProcessContentRepresentation>
|
* @return Promise<ResultListDataRepresentationProcessContentRepresentation>
|
||||||
*/
|
*/
|
||||||
@ -295,7 +283,6 @@ export class ProcessInstancesApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get the process diagram for the process instance
|
* Get the process diagram for the process instance
|
||||||
*
|
|
||||||
* @param processInstanceId processInstanceId
|
* @param processInstanceId processInstanceId
|
||||||
* @return Promise<string>
|
* @return Promise<string>
|
||||||
*/
|
*/
|
||||||
@ -319,7 +306,6 @@ export class ProcessInstancesApi extends BaseApi {
|
|||||||
* Get a process instance start form
|
* Get a process instance start form
|
||||||
*
|
*
|
||||||
* The start form for a process instance can be retrieved when the process definition has a start form defined (hasStartForm = true on the process instance)
|
* The start form for a process instance can be retrieved when the process definition has a start form defined (hasStartForm = true on the process instance)
|
||||||
*
|
|
||||||
* @param processInstanceId processInstanceId
|
* @param processInstanceId processInstanceId
|
||||||
* @return Promise<FormDefinitionRepresentation>
|
* @return Promise<FormDefinitionRepresentation>
|
||||||
*/
|
*/
|
||||||
@ -338,7 +324,6 @@ export class ProcessInstancesApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get a process instance
|
* Get a process instance
|
||||||
*
|
|
||||||
* @param processInstanceId processInstanceId
|
* @param processInstanceId processInstanceId
|
||||||
* @return Promise<ProcessInstanceRepresentation>
|
* @return Promise<ProcessInstanceRepresentation>
|
||||||
*/
|
*/
|
||||||
@ -358,7 +343,6 @@ export class ProcessInstancesApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Query process instances
|
* Query process instances
|
||||||
*
|
|
||||||
* @param processInstancesQuery processInstancesQuery
|
* @param processInstancesQuery processInstancesQuery
|
||||||
* @return Promise<ResultListDataRepresentationProcessInstanceRepresentation>
|
* @return Promise<ResultListDataRepresentationProcessInstanceRepresentation>
|
||||||
*/
|
*/
|
||||||
@ -376,7 +360,6 @@ export class ProcessInstancesApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get the audit log for a process instance
|
* Get the audit log for a process instance
|
||||||
*
|
|
||||||
* @param processInstanceId processInstanceId
|
* @param processInstanceId processInstanceId
|
||||||
* @return Promise<ProcessInstanceAuditInfoRepresentation>
|
* @return Promise<ProcessInstanceAuditInfoRepresentation>
|
||||||
*/
|
*/
|
||||||
@ -395,7 +378,6 @@ export class ProcessInstancesApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Retrieve the process audit in the PDF format
|
* Retrieve the process audit in the PDF format
|
||||||
*
|
|
||||||
* @param processInstanceId processId
|
* @param processInstanceId processId
|
||||||
* @returns process audit
|
* @returns process audit
|
||||||
*/
|
*/
|
||||||
@ -417,7 +399,6 @@ export class ProcessInstancesApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Start a process instance
|
* Start a process instance
|
||||||
*
|
|
||||||
* @param startRequest startRequest
|
* @param startRequest startRequest
|
||||||
* @return Promise<ProcessInstanceRepresentation>
|
* @return Promise<ProcessInstanceRepresentation>
|
||||||
*/
|
*/
|
||||||
@ -433,7 +414,6 @@ export class ProcessInstancesApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Suspend a process instance
|
* Suspend a process instance
|
||||||
*
|
|
||||||
* @param processInstanceId processInstanceId
|
* @param processInstanceId processInstanceId
|
||||||
* @return Promise<ProcessInstanceRepresentation>
|
* @return Promise<ProcessInstanceRepresentation>
|
||||||
*/
|
*/
|
||||||
|
@ -25,7 +25,6 @@ import { throwIfNotDefined } from '../../../assert';
|
|||||||
export class ProcessScopesApi extends BaseApi {
|
export class ProcessScopesApi extends BaseApi {
|
||||||
/**
|
/**
|
||||||
* List runtime process scopes
|
* List runtime process scopes
|
||||||
*
|
|
||||||
* @param processScopesRequest processScopesRequest
|
* @param processScopesRequest processScopesRequest
|
||||||
* @return Promise<ProcessScopeRepresentation>
|
* @return Promise<ProcessScopeRepresentation>
|
||||||
*/
|
*/
|
||||||
|
@ -105,7 +105,6 @@ export class ReportApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Export a report
|
* Export a report
|
||||||
*
|
|
||||||
* @param reportId report id
|
* @param reportId report id
|
||||||
* @param bodyParam body parameters
|
* @param bodyParam body parameters
|
||||||
*/
|
*/
|
||||||
@ -127,7 +126,6 @@ export class ReportApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Save a report
|
* Save a report
|
||||||
*
|
|
||||||
* @param reportId report id
|
* @param reportId report id
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
*/
|
*/
|
||||||
@ -154,7 +152,6 @@ export class ReportApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Delete a report
|
* Delete a report
|
||||||
*
|
|
||||||
* @param reportId report id
|
* @param reportId report id
|
||||||
*/
|
*/
|
||||||
deleteReport(reportId: string) {
|
deleteReport(reportId: string) {
|
||||||
|
@ -31,7 +31,6 @@ export class RuntimeAppDefinitionsApi extends BaseApi {
|
|||||||
* Deploy a published app
|
* Deploy a published app
|
||||||
*
|
*
|
||||||
* Deploying an app allows the user to see it on his/her landing page. Apps must be published before they can be deployed.
|
* Deploying an app allows the user to see it on his/her landing page. Apps must be published before they can be deployed.
|
||||||
*
|
|
||||||
* @param saveObject saveObject
|
* @param saveObject saveObject
|
||||||
* @return Promise<{}>
|
* @return Promise<{}>
|
||||||
*/
|
*/
|
||||||
@ -46,7 +45,6 @@ export class RuntimeAppDefinitionsApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get a runtime app
|
* Get a runtime app
|
||||||
*
|
|
||||||
* @param appDefinitionId appDefinitionId
|
* @param appDefinitionId appDefinitionId
|
||||||
* @return Promise<AppDefinitionRepresentation>
|
* @return Promise<AppDefinitionRepresentation>
|
||||||
*/
|
*/
|
||||||
@ -67,7 +65,6 @@ export class RuntimeAppDefinitionsApi extends BaseApi {
|
|||||||
* List runtime apps
|
* List runtime apps
|
||||||
*
|
*
|
||||||
* When a user logs in into Alfresco Process Services Suite, a landing page is displayed containing all the apps that the user is allowed to see and use. These are referred to as runtime apps.
|
* When a user logs in into Alfresco Process Services Suite, a landing page is displayed containing all the apps that the user is allowed to see and use. These are referred to as runtime apps.
|
||||||
*
|
|
||||||
* @return Promise<ResultListDataRepresentationAppDefinitionRepresentation>
|
* @return Promise<ResultListDataRepresentationAppDefinitionRepresentation>
|
||||||
*/
|
*/
|
||||||
getAppDefinitions(): Promise<ResultListDataRepresentationAppDefinitionRepresentation> {
|
getAppDefinitions(): Promise<ResultListDataRepresentationAppDefinitionRepresentation> {
|
||||||
|
@ -26,7 +26,6 @@ import { throwIfNotDefined } from '../../../assert';
|
|||||||
export class RuntimeAppDeploymentsApi extends BaseApi {
|
export class RuntimeAppDeploymentsApi extends BaseApi {
|
||||||
/**
|
/**
|
||||||
* Remove an app deployment
|
* Remove an app deployment
|
||||||
*
|
|
||||||
* @param appDeploymentId appDeploymentId
|
* @param appDeploymentId appDeploymentId
|
||||||
* @return Promise<{}>
|
* @return Promise<{}>
|
||||||
*/
|
*/
|
||||||
@ -45,7 +44,6 @@ export class RuntimeAppDeploymentsApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Export the app archive for a deployment
|
* Export the app archive for a deployment
|
||||||
*
|
|
||||||
* @param deploymentId deploymentId
|
* @param deploymentId deploymentId
|
||||||
* @return Promise<{}>
|
* @return Promise<{}>
|
||||||
*/
|
*/
|
||||||
@ -67,7 +65,6 @@ export class RuntimeAppDeploymentsApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Query app deployments
|
* Query app deployments
|
||||||
*
|
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
* @return Promise<ResultListDataRepresentationAppDeploymentRepresentation>
|
* @return Promise<ResultListDataRepresentationAppDeploymentRepresentation>
|
||||||
*/
|
*/
|
||||||
@ -89,7 +86,6 @@ export class RuntimeAppDeploymentsApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get an app deployment
|
* Get an app deployment
|
||||||
*
|
|
||||||
* @param appDeploymentId appDeploymentId
|
* @param appDeploymentId appDeploymentId
|
||||||
* @return Promise<AppDeploymentRepresentation>
|
* @return Promise<AppDeploymentRepresentation>
|
||||||
*/
|
*/
|
||||||
@ -110,7 +106,6 @@ export class RuntimeAppDeploymentsApi extends BaseApi {
|
|||||||
/**
|
/**
|
||||||
* Get an app by deployment ID or DMN deployment ID
|
* Get an app by deployment ID or DMN deployment ID
|
||||||
* Either a deploymentId or a dmnDeploymentId must be provided
|
* Either a deploymentId or a dmnDeploymentId must be provided
|
||||||
*
|
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
* @return Promise<AppDeploymentRepresentation>
|
* @return Promise<AppDeploymentRepresentation>
|
||||||
*/
|
*/
|
||||||
|
@ -23,7 +23,6 @@ import { BaseApi } from './base.api';
|
|||||||
export class ScriptFilesApi extends BaseApi {
|
export class ScriptFilesApi extends BaseApi {
|
||||||
/**
|
/**
|
||||||
* getControllers
|
* getControllers
|
||||||
*
|
|
||||||
* @returns Promise<string>
|
* @returns Promise<string>
|
||||||
*/
|
*/
|
||||||
getControllers(): Promise<string> {
|
getControllers(): Promise<string> {
|
||||||
@ -37,7 +36,6 @@ export class ScriptFilesApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* getLibraries
|
* getLibraries
|
||||||
*
|
|
||||||
* @returns Promise<string>
|
* @returns Promise<string>
|
||||||
*/
|
*/
|
||||||
getLibraries(): Promise<string> {
|
getLibraries(): Promise<string> {
|
||||||
|
@ -26,7 +26,6 @@ import { throwIfNotDefined } from '../../../assert';
|
|||||||
export class SubmittedFormsApi extends BaseApi {
|
export class SubmittedFormsApi extends BaseApi {
|
||||||
/**
|
/**
|
||||||
* List submissions for a form
|
* List submissions for a form
|
||||||
*
|
|
||||||
* @param formId formId
|
* @param formId formId
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
* @return Promise<ResultListDataRepresentationSubmittedFormRepresentation>
|
* @return Promise<ResultListDataRepresentationSubmittedFormRepresentation>
|
||||||
@ -51,7 +50,6 @@ export class SubmittedFormsApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* List submissions for a process instance
|
* List submissions for a process instance
|
||||||
*
|
|
||||||
* @param processId processId
|
* @param processId processId
|
||||||
* @return Promise<ResultListDataRepresentationSubmittedFormRepresentation>
|
* @return Promise<ResultListDataRepresentationSubmittedFormRepresentation>
|
||||||
*/
|
*/
|
||||||
@ -71,7 +69,6 @@ export class SubmittedFormsApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get a form submission
|
* Get a form submission
|
||||||
*
|
|
||||||
* @param submittedFormId submittedFormId
|
* @param submittedFormId submittedFormId
|
||||||
* @return Promise<SubmittedFormRepresentation>
|
* @return Promise<SubmittedFormRepresentation>
|
||||||
*/
|
*/
|
||||||
@ -91,7 +88,6 @@ export class SubmittedFormsApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get the submitted form for a task
|
* Get the submitted form for a task
|
||||||
*
|
|
||||||
* @param taskId taskId
|
* @param taskId taskId
|
||||||
* @return Promise<SubmittedFormRepresentation>
|
* @return Promise<SubmittedFormRepresentation>
|
||||||
*/
|
*/
|
||||||
|
@ -25,7 +25,6 @@ import { throwIfNotDefined } from '../../../assert';
|
|||||||
export class SystemPropertiesApi extends BaseApi {
|
export class SystemPropertiesApi extends BaseApi {
|
||||||
/**
|
/**
|
||||||
* Get global date format
|
* Get global date format
|
||||||
*
|
|
||||||
* @param tenantId tenantId
|
* @param tenantId tenantId
|
||||||
* @return Promise<GlobalDateFormatRepresentation>
|
* @return Promise<GlobalDateFormatRepresentation>
|
||||||
*/
|
*/
|
||||||
@ -44,7 +43,6 @@ export class SystemPropertiesApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get password validation constraints
|
* Get password validation constraints
|
||||||
*
|
|
||||||
* @param tenantId tenantId
|
* @param tenantId tenantId
|
||||||
* @return Promise<PasswordValidationConstraints>
|
* @return Promise<PasswordValidationConstraints>
|
||||||
*/
|
*/
|
||||||
@ -65,7 +63,6 @@ export class SystemPropertiesApi extends BaseApi {
|
|||||||
* Retrieve system properties
|
* Retrieve system properties
|
||||||
*
|
*
|
||||||
* Typical value is AllowInvolveByEmail
|
* Typical value is AllowInvolveByEmail
|
||||||
*
|
|
||||||
* @return Promise<SystemPropertiesRepresentation>
|
* @return Promise<SystemPropertiesRepresentation>
|
||||||
*/
|
*/
|
||||||
getProperties(): Promise<SystemPropertiesRepresentation> {
|
getProperties(): Promise<SystemPropertiesRepresentation> {
|
||||||
@ -76,7 +73,6 @@ export class SystemPropertiesApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get involved users who can edit forms
|
* Get involved users who can edit forms
|
||||||
*
|
|
||||||
* @param tenantId tenantId
|
* @param tenantId tenantId
|
||||||
* @return Promise<boolean>
|
* @return Promise<boolean>
|
||||||
*/
|
*/
|
||||||
|
@ -25,7 +25,6 @@ import { throwIfNotDefined } from '../../../assert';
|
|||||||
export class TaskActionsApi extends BaseApi {
|
export class TaskActionsApi extends BaseApi {
|
||||||
/**
|
/**
|
||||||
* Assign a task to a user
|
* Assign a task to a user
|
||||||
*
|
|
||||||
* @param taskId taskId
|
* @param taskId taskId
|
||||||
* @param userIdentifier userIdentifier
|
* @param userIdentifier userIdentifier
|
||||||
* @return Promise<TaskRepresentation>
|
* @return Promise<TaskRepresentation>
|
||||||
@ -48,7 +47,6 @@ export class TaskActionsApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Attach a form to a task
|
* Attach a form to a task
|
||||||
*
|
|
||||||
* @param taskId taskId
|
* @param taskId taskId
|
||||||
* @param formIdentifier formIdentifier
|
* @param formIdentifier formIdentifier
|
||||||
* @return Promise<{}>
|
* @return Promise<{}>
|
||||||
@ -72,7 +70,6 @@ export class TaskActionsApi extends BaseApi {
|
|||||||
* Claim a task
|
* Claim a task
|
||||||
*
|
*
|
||||||
* To claim a task (in case the task is assigned to a group)
|
* To claim a task (in case the task is assigned to a group)
|
||||||
*
|
|
||||||
* @param taskId taskId
|
* @param taskId taskId
|
||||||
* @return Promise<{}>
|
* @return Promise<{}>
|
||||||
*/
|
*/
|
||||||
@ -93,7 +90,6 @@ export class TaskActionsApi extends BaseApi {
|
|||||||
* Complete a task
|
* Complete a task
|
||||||
*
|
*
|
||||||
* Use this endpoint to complete a standalone task or task without a form
|
* Use this endpoint to complete a standalone task or task without a form
|
||||||
*
|
|
||||||
* @param taskId taskId
|
* @param taskId taskId
|
||||||
* @return Promise<{}>
|
* @return Promise<{}>
|
||||||
*/
|
*/
|
||||||
@ -112,7 +108,6 @@ export class TaskActionsApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Delegate a task
|
* Delegate a task
|
||||||
*
|
|
||||||
* @param taskId taskId
|
* @param taskId taskId
|
||||||
* @param userIdentifier userIdentifier
|
* @param userIdentifier userIdentifier
|
||||||
* @return Promise<{}>
|
* @return Promise<{}>
|
||||||
@ -134,7 +129,6 @@ export class TaskActionsApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Involve a group with a task
|
* Involve a group with a task
|
||||||
*
|
|
||||||
* @param taskId taskId
|
* @param taskId taskId
|
||||||
* @param groupId groupId
|
* @param groupId groupId
|
||||||
* @return Promise<{}>
|
* @return Promise<{}>
|
||||||
@ -156,7 +150,6 @@ export class TaskActionsApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Involve a user with a task
|
* Involve a user with a task
|
||||||
*
|
|
||||||
* @param taskId taskId
|
* @param taskId taskId
|
||||||
* @param userIdentifier userIdentifier
|
* @param userIdentifier userIdentifier
|
||||||
* @return Promise<{}>
|
* @return Promise<{}>
|
||||||
@ -178,7 +171,6 @@ export class TaskActionsApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Remove a form from a task
|
* Remove a form from a task
|
||||||
*
|
|
||||||
* @param taskId taskId
|
* @param taskId taskId
|
||||||
* @return Promise<{}>
|
* @return Promise<{}>
|
||||||
*/
|
*/
|
||||||
@ -197,7 +189,6 @@ export class TaskActionsApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Remove an involved group from a task
|
* Remove an involved group from a task
|
||||||
*
|
|
||||||
* @param taskId taskId
|
* @param taskId taskId
|
||||||
* @param identifier identifier
|
* @param identifier identifier
|
||||||
* @return Promise<{}>
|
* @return Promise<{}>
|
||||||
@ -227,9 +218,6 @@ export class TaskActionsApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Resolve a task
|
* Resolve a task
|
||||||
*
|
|
||||||
*
|
|
||||||
*
|
|
||||||
* @param taskId taskId
|
* @param taskId taskId
|
||||||
* @return Promise<{}>
|
* @return Promise<{}>
|
||||||
*/
|
*/
|
||||||
@ -250,7 +238,6 @@ export class TaskActionsApi extends BaseApi {
|
|||||||
* Unclaim a task
|
* Unclaim a task
|
||||||
*
|
*
|
||||||
* To unclaim a task (in case the task was assigned to a group)
|
* To unclaim a task (in case the task was assigned to a group)
|
||||||
*
|
|
||||||
* @param taskId taskId
|
* @param taskId taskId
|
||||||
* @return Promise<{}>
|
* @return Promise<{}>
|
||||||
*/
|
*/
|
||||||
|
@ -31,7 +31,6 @@ import { throwIfNotDefined } from '../../../assert';
|
|||||||
export class TaskFormsApi extends BaseApi {
|
export class TaskFormsApi extends BaseApi {
|
||||||
/**
|
/**
|
||||||
* Complete a task form
|
* Complete a task form
|
||||||
*
|
|
||||||
* @param taskId taskId
|
* @param taskId taskId
|
||||||
* @param completeTaskFormRepresentation completeTaskFormRepresentation
|
* @param completeTaskFormRepresentation completeTaskFormRepresentation
|
||||||
* @return Promise<{}>
|
* @return Promise<{}>
|
||||||
@ -53,7 +52,6 @@ export class TaskFormsApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get task variables
|
* Get task variables
|
||||||
*
|
|
||||||
* @param taskId taskId
|
* @param taskId taskId
|
||||||
* @return Promise<ProcessInstanceVariableRepresentation>
|
* @return Promise<ProcessInstanceVariableRepresentation>
|
||||||
*/
|
*/
|
||||||
@ -73,7 +71,6 @@ export class TaskFormsApi extends BaseApi {
|
|||||||
/**
|
/**
|
||||||
* Retrieve Column Field Values
|
* Retrieve Column Field Values
|
||||||
* Specific case to retrieve information on a specific column
|
* Specific case to retrieve information on a specific column
|
||||||
*
|
|
||||||
* @param taskId taskId
|
* @param taskId taskId
|
||||||
* @param field field
|
* @param field field
|
||||||
* @param column column
|
* @param column column
|
||||||
@ -110,7 +107,6 @@ export class TaskFormsApi extends BaseApi {
|
|||||||
* Retrieve populated field values
|
* Retrieve populated field values
|
||||||
*
|
*
|
||||||
* Form field values that are populated through a REST backend, can be retrieved via this service
|
* Form field values that are populated through a REST backend, can be retrieved via this service
|
||||||
*
|
|
||||||
* @param taskId taskId
|
* @param taskId taskId
|
||||||
* @param field field
|
* @param field field
|
||||||
* @return Promise<FormValueRepresentation []>
|
* @return Promise<FormValueRepresentation []>
|
||||||
@ -132,7 +128,6 @@ export class TaskFormsApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get a task form
|
* Get a task form
|
||||||
*
|
|
||||||
* @param taskId taskId
|
* @param taskId taskId
|
||||||
* @returns Promise<FormDefinitionRepresentation>
|
* @returns Promise<FormDefinitionRepresentation>
|
||||||
*/
|
*/
|
||||||
@ -151,7 +146,6 @@ export class TaskFormsApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Save a task form
|
* Save a task form
|
||||||
*
|
|
||||||
* @param taskId taskId
|
* @param taskId taskId
|
||||||
* @param saveTaskFormRepresentation saveTaskFormRepresentation
|
* @param saveTaskFormRepresentation saveTaskFormRepresentation
|
||||||
* @return Promise<{}>
|
* @return Promise<{}>
|
||||||
@ -173,7 +167,6 @@ export class TaskFormsApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Retrieve Task Form Variables
|
* Retrieve Task Form Variables
|
||||||
*
|
|
||||||
* @param taskId taskId
|
* @param taskId taskId
|
||||||
*/
|
*/
|
||||||
getTaskFormVariables(taskId: string) {
|
getTaskFormVariables(taskId: string) {
|
||||||
|
@ -26,7 +26,6 @@ import { ScopeQuery } from './types';
|
|||||||
export class TaskVariablesApi extends BaseApi {
|
export class TaskVariablesApi extends BaseApi {
|
||||||
/**
|
/**
|
||||||
* Create variables
|
* Create variables
|
||||||
*
|
|
||||||
* @param taskId taskId
|
* @param taskId taskId
|
||||||
* @param restVariables restVariables
|
* @param restVariables restVariables
|
||||||
* @return Promise<RestVariable>
|
* @return Promise<RestVariable>
|
||||||
@ -48,7 +47,6 @@ export class TaskVariablesApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Create or update variables
|
* Create or update variables
|
||||||
*
|
|
||||||
* @param taskId taskId
|
* @param taskId taskId
|
||||||
* @return Promise<{}>
|
* @return Promise<{}>
|
||||||
*/
|
*/
|
||||||
@ -67,7 +65,6 @@ export class TaskVariablesApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Delete a variable
|
* Delete a variable
|
||||||
*
|
|
||||||
* @param taskId taskId
|
* @param taskId taskId
|
||||||
* @param variableName variableName
|
* @param variableName variableName
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
@ -90,7 +87,6 @@ export class TaskVariablesApi extends BaseApi {
|
|||||||
}
|
}
|
||||||
/**
|
/**
|
||||||
* Get a variable
|
* Get a variable
|
||||||
*
|
|
||||||
* @param taskId taskId
|
* @param taskId taskId
|
||||||
* @param variableName variableName
|
* @param variableName variableName
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
@ -114,7 +110,6 @@ export class TaskVariablesApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* List variables
|
* List variables
|
||||||
*
|
|
||||||
* @param taskId taskId
|
* @param taskId taskId
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
* @return Promise<RestVariable>
|
* @return Promise<RestVariable>
|
||||||
@ -135,7 +130,6 @@ export class TaskVariablesApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Update a variable
|
* Update a variable
|
||||||
*
|
|
||||||
* @param taskId taskId
|
* @param taskId taskId
|
||||||
* @param variableName variableName
|
* @param variableName variableName
|
||||||
* @param restVariable restVariable
|
* @param restVariable restVariable
|
||||||
|
@ -34,7 +34,6 @@ import { throwIfNotDefined } from '../../../assert';
|
|||||||
export class TasksApi extends BaseApi {
|
export class TasksApi extends BaseApi {
|
||||||
/**
|
/**
|
||||||
* List the users and groups involved with a task
|
* List the users and groups involved with a task
|
||||||
*
|
|
||||||
* @param taskId taskId
|
* @param taskId taskId
|
||||||
* @param identityLinkRepresentation identityLinkRepresentation
|
* @param identityLinkRepresentation identityLinkRepresentation
|
||||||
* @returns Promise<IdentityLinkRepresentation>
|
* @returns Promise<IdentityLinkRepresentation>
|
||||||
@ -58,7 +57,6 @@ export class TasksApi extends BaseApi {
|
|||||||
* Create a standalone task
|
* Create a standalone task
|
||||||
*
|
*
|
||||||
* A standalone task is one which is not associated with any process instance.
|
* A standalone task is one which is not associated with any process instance.
|
||||||
*
|
|
||||||
* @param taskRepresentation taskRepresentation
|
* @param taskRepresentation taskRepresentation
|
||||||
* @returns Promise<TaskRepresentation>
|
* @returns Promise<TaskRepresentation>
|
||||||
*/
|
*/
|
||||||
@ -74,7 +72,6 @@ export class TasksApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Remove a user or group involvement from a task
|
* Remove a user or group involvement from a task
|
||||||
*
|
|
||||||
* @param taskId taskId
|
* @param taskId taskId
|
||||||
* @param family family
|
* @param family family
|
||||||
* @param identityId identityId
|
* @param identityId identityId
|
||||||
@ -102,7 +99,6 @@ export class TasksApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Delete a task
|
* Delete a task
|
||||||
*
|
|
||||||
* @param taskId taskId
|
* @param taskId taskId
|
||||||
* @returns Promise<{}>
|
* @returns Promise<{}>
|
||||||
*/
|
*/
|
||||||
@ -121,7 +117,6 @@ export class TasksApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Filter a list of tasks
|
* Filter a list of tasks
|
||||||
*
|
|
||||||
* @param tasksFilter tasksFilter
|
* @param tasksFilter tasksFilter
|
||||||
* @returns Promise<ResultListDataRepresentationTaskRepresentation>
|
* @returns Promise<ResultListDataRepresentationTaskRepresentation>
|
||||||
*/
|
*/
|
||||||
@ -137,7 +132,6 @@ export class TasksApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get a user or group involvement with a task
|
* Get a user or group involvement with a task
|
||||||
*
|
|
||||||
* @param taskId taskId
|
* @param taskId taskId
|
||||||
* @param family family
|
* @param family family
|
||||||
* @param identityId identityId
|
* @param identityId identityId
|
||||||
@ -165,7 +159,6 @@ export class TasksApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* List either the users or groups involved with a process instance
|
* List either the users or groups involved with a process instance
|
||||||
*
|
|
||||||
* @param taskId taskId
|
* @param taskId taskId
|
||||||
* @param family family
|
* @param family family
|
||||||
* @returns Promise<IdentityLinkRepresentation>
|
* @returns Promise<IdentityLinkRepresentation>
|
||||||
@ -187,7 +180,6 @@ export class TasksApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* getIdentityLinks
|
* getIdentityLinks
|
||||||
*
|
|
||||||
* @param taskId taskId
|
* @param taskId taskId
|
||||||
* @returns Promise<IdentityLinkRepresentation>
|
* @returns Promise<IdentityLinkRepresentation>
|
||||||
*/
|
*/
|
||||||
@ -206,7 +198,6 @@ export class TasksApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get the audit log for a task
|
* Get the audit log for a task
|
||||||
*
|
|
||||||
* @param taskId taskId
|
* @param taskId taskId
|
||||||
* @returns Promise<TaskAuditInfoRepresentation>
|
* @returns Promise<TaskAuditInfoRepresentation>
|
||||||
*/
|
*/
|
||||||
@ -225,7 +216,6 @@ export class TasksApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get the audit log for a task
|
* Get the audit log for a task
|
||||||
*
|
|
||||||
* @param taskId taskId
|
* @param taskId taskId
|
||||||
* @returns Promise<Blob> task audit in blob
|
* @returns Promise<Blob> task audit in blob
|
||||||
*/
|
*/
|
||||||
@ -246,7 +236,6 @@ export class TasksApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get a task
|
* Get a task
|
||||||
*
|
|
||||||
* @param taskId taskId
|
* @param taskId taskId
|
||||||
* @returns Promise<TaskRepresentation>
|
* @returns Promise<TaskRepresentation>
|
||||||
*/
|
*/
|
||||||
@ -266,7 +255,6 @@ export class TasksApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Query historic tasks
|
* Query historic tasks
|
||||||
*
|
|
||||||
* @param queryRequest queryRequest
|
* @param queryRequest queryRequest
|
||||||
* @returns Promise<ResultListDataRepresentationTaskRepresentation>
|
* @returns Promise<ResultListDataRepresentationTaskRepresentation>
|
||||||
*/
|
*/
|
||||||
@ -282,7 +270,6 @@ export class TasksApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* List tasks
|
* List tasks
|
||||||
*
|
|
||||||
* @param tasksQuery tasksQuery
|
* @param tasksQuery tasksQuery
|
||||||
* @returns Promise<ResultListDataRepresentationTaskRepresentation>
|
* @returns Promise<ResultListDataRepresentationTaskRepresentation>
|
||||||
*/
|
*/
|
||||||
@ -300,7 +287,6 @@ export class TasksApi extends BaseApi {
|
|||||||
* Update a task
|
* Update a task
|
||||||
*
|
*
|
||||||
* You can edit only name, description and dueDate (ISO 8601 string).
|
* You can edit only name, description and dueDate (ISO 8601 string).
|
||||||
*
|
|
||||||
* @param taskId taskId
|
* @param taskId taskId
|
||||||
* @param updated updated
|
* @param updated updated
|
||||||
* @returns Promise<TaskRepresentation>
|
* @returns Promise<TaskRepresentation>
|
||||||
|
@ -23,7 +23,6 @@ import { BaseApi } from './base.api';
|
|||||||
export class TemporaryApi extends BaseApi {
|
export class TemporaryApi extends BaseApi {
|
||||||
/**
|
/**
|
||||||
* completeTasks
|
* completeTasks
|
||||||
*
|
|
||||||
* @param userId userId
|
* @param userId userId
|
||||||
* @param processDefinitionKey processDefinitionKey
|
* @param processDefinitionKey processDefinitionKey
|
||||||
*/
|
*/
|
||||||
@ -51,7 +50,6 @@ export class TemporaryApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* generateData
|
* generateData
|
||||||
*
|
|
||||||
* @param userId userId
|
* @param userId userId
|
||||||
* @param processDefinitionKey processDefinitionKey
|
* @param processDefinitionKey processDefinitionKey
|
||||||
*/
|
*/
|
||||||
|
@ -32,7 +32,6 @@ import { AppIdQuery } from './types';
|
|||||||
export class UserFiltersApi extends BaseApi {
|
export class UserFiltersApi extends BaseApi {
|
||||||
/**
|
/**
|
||||||
* Create a process instance filter
|
* Create a process instance filter
|
||||||
*
|
|
||||||
* @param userProcessInstanceFilterRepresentation userProcessInstanceFilterRepresentation
|
* @param userProcessInstanceFilterRepresentation userProcessInstanceFilterRepresentation
|
||||||
* @returns Promise<UserProcessInstanceFilterRepresentation>
|
* @returns Promise<UserProcessInstanceFilterRepresentation>
|
||||||
*/
|
*/
|
||||||
@ -49,7 +48,6 @@ export class UserFiltersApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Create a task filter
|
* Create a task filter
|
||||||
*
|
|
||||||
* @param userTaskFilterRepresentation userTaskFilterRepresentation
|
* @param userTaskFilterRepresentation userTaskFilterRepresentation
|
||||||
* @returns Promise<UserTaskFilterRepresentation>
|
* @returns Promise<UserTaskFilterRepresentation>
|
||||||
*/
|
*/
|
||||||
@ -65,7 +63,6 @@ export class UserFiltersApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Delete a process instance filter
|
* Delete a process instance filter
|
||||||
*
|
|
||||||
* @param userFilterId userFilterId
|
* @param userFilterId userFilterId
|
||||||
* @returns Promise<{}>
|
* @returns Promise<{}>
|
||||||
*/
|
*/
|
||||||
@ -84,7 +81,6 @@ export class UserFiltersApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Delete a task filter
|
* Delete a task filter
|
||||||
*
|
|
||||||
* @param userFilterId userFilterId
|
* @param userFilterId userFilterId
|
||||||
* @returns Promise<{}>
|
* @returns Promise<{}>
|
||||||
*/
|
*/
|
||||||
@ -103,7 +99,6 @@ export class UserFiltersApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get a process instance filter
|
* Get a process instance filter
|
||||||
*
|
|
||||||
* @param userFilterId userFilterId
|
* @param userFilterId userFilterId
|
||||||
* @returns Promise<UserProcessInstanceFilterRepresentation>
|
* @returns Promise<UserProcessInstanceFilterRepresentation>
|
||||||
*/
|
*/
|
||||||
@ -124,7 +119,6 @@ export class UserFiltersApi extends BaseApi {
|
|||||||
* List process instance filters
|
* List process instance filters
|
||||||
*
|
*
|
||||||
* Returns filters for the current user, optionally filtered by *appId*.
|
* Returns filters for the current user, optionally filtered by *appId*.
|
||||||
*
|
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
* @returns Promise<ResultListDataRepresentationUserProcessInstanceFilterRepresentation>
|
* @returns Promise<ResultListDataRepresentationUserProcessInstanceFilterRepresentation>
|
||||||
*/
|
*/
|
||||||
@ -137,7 +131,6 @@ export class UserFiltersApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get a task filter
|
* Get a task filter
|
||||||
*
|
|
||||||
* @param userFilterId userFilterId
|
* @param userFilterId userFilterId
|
||||||
* @returns Promise<UserTaskFilterRepresentation>
|
* @returns Promise<UserTaskFilterRepresentation>
|
||||||
*/
|
*/
|
||||||
@ -159,7 +152,6 @@ export class UserFiltersApi extends BaseApi {
|
|||||||
* List task filters
|
* List task filters
|
||||||
*
|
*
|
||||||
* Returns filters for the current user, optionally filtered by *appId*.
|
* Returns filters for the current user, optionally filtered by *appId*.
|
||||||
*
|
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
* @returns Promise<ResultListDataRepresentationUserTaskFilterRepresentation>
|
* @returns Promise<ResultListDataRepresentationUserTaskFilterRepresentation>
|
||||||
*/
|
*/
|
||||||
@ -173,7 +165,6 @@ export class UserFiltersApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Re-order the list of user process instance filters
|
* Re-order the list of user process instance filters
|
||||||
*
|
|
||||||
* @param filterOrderRepresentation filterOrderRepresentation
|
* @param filterOrderRepresentation filterOrderRepresentation
|
||||||
* @returns Promise<{}>
|
* @returns Promise<{}>
|
||||||
*/
|
*/
|
||||||
@ -188,7 +179,6 @@ export class UserFiltersApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Re-order the list of user task filters
|
* Re-order the list of user task filters
|
||||||
*
|
|
||||||
* @param filterOrderRepresentation filterOrderRepresentation
|
* @param filterOrderRepresentation filterOrderRepresentation
|
||||||
* @returns Promise<{}>
|
* @returns Promise<{}>
|
||||||
*/
|
*/
|
||||||
@ -203,7 +193,6 @@ export class UserFiltersApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Update a process instance filter
|
* Update a process instance filter
|
||||||
*
|
|
||||||
* @param userFilterId userFilterId
|
* @param userFilterId userFilterId
|
||||||
* @param userProcessInstanceFilterRepresentation userProcessInstanceFilterRepresentation
|
* @param userProcessInstanceFilterRepresentation userProcessInstanceFilterRepresentation
|
||||||
* @returns Promise<UserProcessInstanceFilterRepresentation>
|
* @returns Promise<UserProcessInstanceFilterRepresentation>
|
||||||
@ -228,7 +217,6 @@ export class UserFiltersApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Update a task filter
|
* Update a task filter
|
||||||
*
|
|
||||||
* @param userFilterId userFilterId
|
* @param userFilterId userFilterId
|
||||||
* @param userTaskFilterRepresentation userTaskFilterRepresentation
|
* @param userTaskFilterRepresentation userTaskFilterRepresentation
|
||||||
* @returns Promise<UserTaskFilterRepresentation>
|
* @returns Promise<UserTaskFilterRepresentation>
|
||||||
|
@ -27,7 +27,6 @@ import { throwIfNotDefined } from '../../../assert';
|
|||||||
export class UserProfileApi extends BaseApi {
|
export class UserProfileApi extends BaseApi {
|
||||||
/**
|
/**
|
||||||
* Change user password
|
* Change user password
|
||||||
*
|
|
||||||
* @param changePasswordRepresentation changePasswordRepresentation
|
* @param changePasswordRepresentation changePasswordRepresentation
|
||||||
* @return Promise<{}>
|
* @return Promise<{}>
|
||||||
*/
|
*/
|
||||||
@ -43,7 +42,6 @@ export class UserProfileApi extends BaseApi {
|
|||||||
/**
|
/**
|
||||||
* Retrieve user profile picture
|
* Retrieve user profile picture
|
||||||
* Generally returns an image file
|
* Generally returns an image file
|
||||||
*
|
|
||||||
* @return Promise<Blob>
|
* @return Promise<Blob>
|
||||||
*/
|
*/
|
||||||
getProfilePicture(): Promise<any> {
|
getProfilePicture(): Promise<any> {
|
||||||
@ -65,7 +63,6 @@ export class UserProfileApi extends BaseApi {
|
|||||||
* Get user profile
|
* Get user profile
|
||||||
* This operation returns account information for the current user.
|
* This operation returns account information for the current user.
|
||||||
* This is useful to get the name, email, the groups that the user is part of, the user picture, etc.
|
* This is useful to get the name, email, the groups that the user is part of, the user picture, etc.
|
||||||
*
|
|
||||||
* @return Promise<UserRepresentation>
|
* @return Promise<UserRepresentation>
|
||||||
*/
|
*/
|
||||||
getProfile(): Promise<UserRepresentation> {
|
getProfile(): Promise<UserRepresentation> {
|
||||||
@ -78,7 +75,6 @@ export class UserProfileApi extends BaseApi {
|
|||||||
/**
|
/**
|
||||||
* Update user profile.
|
* Update user profile.
|
||||||
* Only a first name, last name, email and company can be updated
|
* Only a first name, last name, email and company can be updated
|
||||||
*
|
|
||||||
* @param userRepresentation userRepresentation
|
* @param userRepresentation userRepresentation
|
||||||
* @return Promise<UserRepresentation>
|
* @return Promise<UserRepresentation>
|
||||||
*/
|
*/
|
||||||
@ -94,7 +90,6 @@ export class UserProfileApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Change user profile picture
|
* Change user profile picture
|
||||||
*
|
|
||||||
* @param file file
|
* @param file file
|
||||||
* @return Promise<ImageUploadRepresentation>
|
* @return Promise<ImageUploadRepresentation>
|
||||||
*/
|
*/
|
||||||
|
@ -41,7 +41,6 @@ export class UsersApi extends BaseApi {
|
|||||||
* Execute an action for a specific user
|
* Execute an action for a specific user
|
||||||
*
|
*
|
||||||
* Typical action is updating/reset password
|
* Typical action is updating/reset password
|
||||||
*
|
|
||||||
* @param userId userId
|
* @param userId userId
|
||||||
* @param actionRequest actionRequest
|
* @param actionRequest actionRequest
|
||||||
* @returns Promise<{}>
|
* @returns Promise<{}>
|
||||||
@ -63,7 +62,6 @@ export class UsersApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Stream user profile picture
|
* Stream user profile picture
|
||||||
*
|
|
||||||
* @param userId userId
|
* @param userId userId
|
||||||
* @returns Promise<{}>
|
* @returns Promise<{}>
|
||||||
*/
|
*/
|
||||||
@ -73,7 +71,6 @@ export class UsersApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get a user
|
* Get a user
|
||||||
*
|
|
||||||
* @param userId userId
|
* @param userId userId
|
||||||
* @returns Promise<UserRepresentation>
|
* @returns Promise<UserRepresentation>
|
||||||
*/
|
*/
|
||||||
@ -95,7 +92,6 @@ export class UsersApi extends BaseApi {
|
|||||||
* Query users
|
* Query users
|
||||||
*
|
*
|
||||||
* A common use case is that a user wants to select another user (eg. when assigning a task) or group.
|
* A common use case is that a user wants to select another user (eg. when assigning a task) or group.
|
||||||
*
|
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
* @returns Promise<ResultListDataRepresentationLightUserRepresentation>
|
* @returns Promise<ResultListDataRepresentationLightUserRepresentation>
|
||||||
*/
|
*/
|
||||||
@ -121,7 +117,6 @@ export class UsersApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Request a password reset
|
* Request a password reset
|
||||||
*
|
|
||||||
* @param resetPassword resetPassword
|
* @param resetPassword resetPassword
|
||||||
* @returns Promise<{}>
|
* @returns Promise<{}>
|
||||||
*/
|
*/
|
||||||
@ -136,7 +131,6 @@ export class UsersApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Update a user
|
* Update a user
|
||||||
*
|
|
||||||
* @param userId userId
|
* @param userId userId
|
||||||
* @param userRequest userRequest
|
* @param userRequest userRequest
|
||||||
* @returns Promise<UserRepresentation>
|
* @returns Promise<UserRepresentation>
|
||||||
|
@ -29,7 +29,6 @@ export class AuthenticationApi extends BaseApi {
|
|||||||
* Create ticket (login)
|
* Create ticket (login)
|
||||||
*
|
*
|
||||||
* **Note:** this endpoint is available in Alfresco 5.2 and newer versions.
|
* **Note:** this endpoint is available in Alfresco 5.2 and newer versions.
|
||||||
*
|
|
||||||
* @param ticketBodyCreate The user credential.
|
* @param ticketBodyCreate The user credential.
|
||||||
* @returns Promise<TicketEntry>
|
* @returns Promise<TicketEntry>
|
||||||
*/
|
*/
|
||||||
@ -45,7 +44,6 @@ export class AuthenticationApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get ticket (login)
|
* Get ticket (login)
|
||||||
*
|
|
||||||
* @returns Promise<TicketEntry>
|
* @returns Promise<TicketEntry>
|
||||||
*/
|
*/
|
||||||
getTicket(): Promise<TicketEntry> {
|
getTicket(): Promise<TicketEntry> {
|
||||||
@ -59,7 +57,6 @@ export class AuthenticationApi extends BaseApi {
|
|||||||
* Delete ticket (logout)
|
* Delete ticket (logout)
|
||||||
*
|
*
|
||||||
* **Note:** this endpoint is available in Alfresco 5.2 and newer versions.
|
* **Note:** this endpoint is available in Alfresco 5.2 and newer versions.
|
||||||
*
|
|
||||||
* @returns Promise<{}>
|
* @returns Promise<{}>
|
||||||
*/
|
*/
|
||||||
deleteTicket(): Promise<void> {
|
deleteTicket(): Promise<void> {
|
||||||
@ -77,7 +74,6 @@ export class AuthenticationApi extends BaseApi {
|
|||||||
* For example, you can pass the Authorization request header using Javascript:
|
* For example, you can pass the Authorization request header using Javascript:
|
||||||
* Javascript
|
* Javascript
|
||||||
* request.setRequestHeader (\"Authorization\", \"Basic \" + btoa(ticket));
|
* request.setRequestHeader (\"Authorization\", \"Basic \" + btoa(ticket));
|
||||||
*
|
|
||||||
* @returns Promise<ValidTicketEntry>
|
* @returns Promise<ValidTicketEntry>
|
||||||
*/
|
*/
|
||||||
validateTicket(): Promise<ValidTicketEntry> {
|
validateTicket(): Promise<ValidTicketEntry> {
|
||||||
|
@ -24,7 +24,6 @@ import { BaseApi } from './base.api';
|
|||||||
export class ClassesApi extends BaseApi {
|
export class ClassesApi extends BaseApi {
|
||||||
/**
|
/**
|
||||||
* Gets the class information for the specified className.
|
* Gets the class information for the specified className.
|
||||||
*
|
|
||||||
* @param className The identifier of the class.
|
* @param className The identifier of the class.
|
||||||
* @returns a Promise, with data of type ClassDescription
|
* @returns a Promise, with data of type ClassDescription
|
||||||
*/
|
*/
|
||||||
|
@ -18,125 +18,159 @@
|
|||||||
import { BaseApi } from './base.api';
|
import { BaseApi } from './base.api';
|
||||||
|
|
||||||
export class ContentApi extends BaseApi {
|
export class ContentApi extends BaseApi {
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Get thumbnail URL for the given nodeId
|
* Get thumbnail URL for the given nodeId
|
||||||
*
|
|
||||||
* @param nodeId The ID of the document node
|
* @param nodeId The ID of the document node
|
||||||
* @param [attachment=false] Retrieve content as an attachment for download
|
* @param [attachment] Retrieve content as an attachment for download
|
||||||
* @param [ticket] Custom ticket to use for authentication
|
* @param [ticket] Custom ticket to use for authentication
|
||||||
* @returns The URL address pointing to the content.
|
* @returns The URL address pointing to the content.
|
||||||
*/
|
*/
|
||||||
getDocumentThumbnailUrl(nodeId: string, attachment?: boolean, ticket?: string): string {
|
getDocumentThumbnailUrl(nodeId: string, attachment?: boolean, ticket?: string): string {
|
||||||
return this.apiClient.basePath + '/nodes/' + nodeId +
|
return (
|
||||||
|
this.apiClient.basePath +
|
||||||
|
'/nodes/' +
|
||||||
|
nodeId +
|
||||||
'/renditions/doclib/content' +
|
'/renditions/doclib/content' +
|
||||||
'?attachment=' + (attachment ? 'true' : 'false') +
|
'?attachment=' +
|
||||||
this.apiClient.getAlfTicket(ticket);
|
(attachment ? 'true' : 'false') +
|
||||||
|
this.apiClient.getAlfTicket(ticket)
|
||||||
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Get preview URL for the given nodeId
|
* Get preview URL for the given nodeId
|
||||||
*
|
|
||||||
* @param nodeId The ID of the document node
|
* @param nodeId The ID of the document node
|
||||||
* @param [attachment=false] Retrieve content as an attachment for download
|
* @param [attachment] Retrieve content as an attachment for download
|
||||||
* @param [ticket] Custom ticket to use for authentication
|
* @param [ticket] Custom ticket to use for authentication
|
||||||
* @returns The URL address pointing to the content.
|
* @returns The URL address pointing to the content.
|
||||||
*/
|
*/
|
||||||
getDocumentPreviewUrl(nodeId: string, attachment?: boolean, ticket?: string): string {
|
getDocumentPreviewUrl(nodeId: string, attachment?: boolean, ticket?: string): string {
|
||||||
return this.apiClient.basePath + '/nodes/' + nodeId +
|
return (
|
||||||
|
this.apiClient.basePath +
|
||||||
|
'/nodes/' +
|
||||||
|
nodeId +
|
||||||
'/renditions/imgpreview/content' +
|
'/renditions/imgpreview/content' +
|
||||||
'?attachment=' + (attachment ? 'true' : 'false') +
|
'?attachment=' +
|
||||||
this.apiClient.getAlfTicket(ticket);
|
(attachment ? 'true' : 'false') +
|
||||||
|
this.apiClient.getAlfTicket(ticket)
|
||||||
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Get content URL for the given nodeId
|
* Get content URL for the given nodeId
|
||||||
*
|
|
||||||
* @param nodeId The ID of the document node
|
* @param nodeId The ID of the document node
|
||||||
* @param [attachment=false] Retrieve content as an attachment for download
|
* @param [attachment] Retrieve content as an attachment for download
|
||||||
* @param [ticket] Custom ticket to use for authentication
|
* @param [ticket] Custom ticket to use for authentication
|
||||||
* @returns The URL address pointing to the content.
|
* @returns The URL address pointing to the content.
|
||||||
*/
|
*/
|
||||||
getContentUrl(nodeId: string, attachment?: boolean, ticket?: string): string {
|
getContentUrl(nodeId: string, attachment?: boolean, ticket?: string): string {
|
||||||
return this.apiClient.basePath + '/nodes/' + nodeId +
|
return (
|
||||||
|
this.apiClient.basePath +
|
||||||
|
'/nodes/' +
|
||||||
|
nodeId +
|
||||||
'/content' +
|
'/content' +
|
||||||
'?attachment=' + (attachment ? 'true' : 'false') +
|
'?attachment=' +
|
||||||
this.apiClient.getAlfTicket(ticket);
|
(attachment ? 'true' : 'false') +
|
||||||
|
this.apiClient.getAlfTicket(ticket)
|
||||||
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Get rendition URL for the given nodeId
|
* Get rendition URL for the given nodeId
|
||||||
*
|
|
||||||
* @param nodeId The ID of the document node
|
* @param nodeId The ID of the document node
|
||||||
* @param encoding of the document
|
* @param encoding of the document
|
||||||
* @param [attachment=false] retrieve content as an attachment for download
|
* @param [attachment] retrieve content as an attachment for download
|
||||||
* @param [ticket] Custom ticket to use for authentication
|
* @param [ticket] Custom ticket to use for authentication
|
||||||
* @returns The URL address pointing to the content.
|
* @returns The URL address pointing to the content.
|
||||||
*/
|
*/
|
||||||
getRenditionUrl(nodeId: string, encoding: string, attachment?: boolean, ticket?: string): string {
|
getRenditionUrl(nodeId: string, encoding: string, attachment?: boolean, ticket?: string): string {
|
||||||
return this.apiClient.basePath + '/nodes/' + nodeId +
|
return (
|
||||||
'/renditions/' + encoding + '/content' +
|
this.apiClient.basePath +
|
||||||
'?attachment=' + (attachment ? 'true' : 'false') +
|
'/nodes/' +
|
||||||
this.apiClient.getAlfTicket(ticket);
|
nodeId +
|
||||||
|
'/renditions/' +
|
||||||
|
encoding +
|
||||||
|
'/content' +
|
||||||
|
'?attachment=' +
|
||||||
|
(attachment ? 'true' : 'false') +
|
||||||
|
this.apiClient.getAlfTicket(ticket)
|
||||||
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Get version's rendition URL for the given nodeId
|
* Get version's rendition URL for the given nodeId
|
||||||
*
|
|
||||||
* @param nodeId The ID of the document node
|
* @param nodeId The ID of the document node
|
||||||
* @param versionId The ID of the version
|
* @param versionId The ID of the version
|
||||||
* @param encoding of the document
|
* @param encoding of the document
|
||||||
* @param [attachment=false] retrieve content as an attachment for download
|
* @param [attachment] retrieve content as an attachment for download
|
||||||
* @param [ticket] Custom ticket to use for authentication
|
* @param [ticket] Custom ticket to use for authentication
|
||||||
* @returns The URL address pointing to the content.
|
* @returns The URL address pointing to the content.
|
||||||
*/
|
*/
|
||||||
getVersionRenditionUrl(nodeId: string, versionId: string, encoding: string, attachment?: boolean, ticket?: string): string {
|
getVersionRenditionUrl(nodeId: string, versionId: string, encoding: string, attachment?: boolean, ticket?: string): string {
|
||||||
return this.apiClient.basePath + '/nodes/' + nodeId + '/versions/' + versionId +
|
return (
|
||||||
'/renditions/' + encoding + '/content' +
|
this.apiClient.basePath +
|
||||||
'?attachment=' + (attachment ? 'true' : 'false') +
|
'/nodes/' +
|
||||||
this.apiClient.getAlfTicket(ticket);
|
nodeId +
|
||||||
|
'/versions/' +
|
||||||
|
versionId +
|
||||||
|
'/renditions/' +
|
||||||
|
encoding +
|
||||||
|
'/content' +
|
||||||
|
'?attachment=' +
|
||||||
|
(attachment ? 'true' : 'false') +
|
||||||
|
this.apiClient.getAlfTicket(ticket)
|
||||||
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Get content URL for the given nodeId and versionId
|
* Get content URL for the given nodeId and versionId
|
||||||
*
|
|
||||||
* @param nodeId The ID of the document node
|
* @param nodeId The ID of the document node
|
||||||
* @param versionId The ID of the version
|
* @param versionId The ID of the version
|
||||||
* @param [attachment=false] Retrieve content as an attachment for download
|
* @param [attachment] Retrieve content as an attachment for download
|
||||||
* @param [ticket] Custom ticket to use for authentication
|
* @param [ticket] Custom ticket to use for authentication
|
||||||
* @returns The URL address pointing to the content.
|
* @returns The URL address pointing to the content.
|
||||||
*/
|
*/
|
||||||
getVersionContentUrl(nodeId: string, versionId: string, attachment?: boolean, ticket?: string): string {
|
getVersionContentUrl(nodeId: string, versionId: string, attachment?: boolean, ticket?: string): string {
|
||||||
return this.apiClient.basePath + '/nodes/' + nodeId +
|
return (
|
||||||
'/versions/' + versionId + '/content' +
|
this.apiClient.basePath +
|
||||||
'?attachment=' + (attachment ? 'true' : 'false') +
|
'/nodes/' +
|
||||||
this.apiClient.getAlfTicket(ticket);
|
nodeId +
|
||||||
|
'/versions/' +
|
||||||
|
versionId +
|
||||||
|
'/content' +
|
||||||
|
'?attachment=' +
|
||||||
|
(attachment ? 'true' : 'false') +
|
||||||
|
this.apiClient.getAlfTicket(ticket)
|
||||||
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Get content url for the given shared link id
|
* Get content url for the given shared link id
|
||||||
*
|
|
||||||
* @param linkId - The ID of the shared link
|
* @param linkId - The ID of the shared link
|
||||||
* @param [attachment=false] Retrieve content as an attachment for download
|
* @param [attachment] Retrieve content as an attachment for download
|
||||||
* @returns The URL address pointing to the content.
|
* @returns The URL address pointing to the content.
|
||||||
*/
|
*/
|
||||||
getSharedLinkContentUrl(linkId: string, attachment?: boolean): string {
|
getSharedLinkContentUrl(linkId: string, attachment?: boolean): string {
|
||||||
return this.apiClient.basePath + '/shared-links/' + linkId +
|
return this.apiClient.basePath + '/shared-links/' + linkId + '/content' + '?attachment=' + (attachment ? 'true' : 'false');
|
||||||
'/content' +
|
|
||||||
'?attachment=' + (attachment ? 'true' : 'false');
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Gets the rendition content for file with shared link identifier sharedId.
|
* Gets the rendition content for file with shared link identifier sharedId.
|
||||||
*
|
|
||||||
* @param sharedId - The identifier of a shared link to a file.
|
* @param sharedId - The identifier of a shared link to a file.
|
||||||
* @param renditionId - The name of a thumbnail rendition, for example doclib, or pdf.
|
* @param renditionId - The name of a thumbnail rendition, for example doclib, or pdf.
|
||||||
* @param [attachment=false] Retrieve content as an attachment for download
|
* @param [attachment] Retrieve content as an attachment for download
|
||||||
* @returns The URL address pointing to the content.
|
* @returns The URL address pointing to the content.
|
||||||
*/
|
*/
|
||||||
getSharedLinkRenditionUrl(sharedId: string, renditionId: string, attachment?: boolean): string {
|
getSharedLinkRenditionUrl(sharedId: string, renditionId: string, attachment?: boolean): string {
|
||||||
return this.apiClient.basePath + '/shared-links/' + sharedId +
|
return (
|
||||||
'/renditions/' + renditionId + '/content' +
|
this.apiClient.basePath +
|
||||||
'?attachment=' + (attachment ? 'true' : 'false');
|
'/shared-links/' +
|
||||||
|
sharedId +
|
||||||
|
'/renditions/' +
|
||||||
|
renditionId +
|
||||||
|
'/content' +
|
||||||
|
'?attachment=' +
|
||||||
|
(attachment ? 'true' : 'false')
|
||||||
|
);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@ -27,7 +27,6 @@ export class WebscriptApi extends BaseApi {
|
|||||||
* Call a get on a Web Scripts see https://wiki.alfresco.com/wiki/Web_Scripts for more details about Web Scripts
|
* Call a get on a Web Scripts see https://wiki.alfresco.com/wiki/Web_Scripts for more details about Web Scripts
|
||||||
* Url syntax definition : http[s]://<host>:<port>/[<contextPath>/]/<servicePath>[/<scriptPath>][?<scriptArgs>]
|
* Url syntax definition : http[s]://<host>:<port>/[<contextPath>/]/<servicePath>[/<scriptPath>][?<scriptArgs>]
|
||||||
* example: http://localhost:8081/share/service/mytasks?priority=1
|
* example: http://localhost:8081/share/service/mytasks?priority=1
|
||||||
*
|
|
||||||
* @param httpMethod GET, POST, PUT and DELETE
|
* @param httpMethod GET, POST, PUT and DELETE
|
||||||
* @param scriptPath script path
|
* @param scriptPath script path
|
||||||
* @param scriptArgs script arguments
|
* @param scriptArgs script arguments
|
||||||
|
@ -18,7 +18,6 @@
|
|||||||
export class DateAlfresco extends Date {
|
export class DateAlfresco extends Date {
|
||||||
/**
|
/**
|
||||||
* Parses an ISO-8601 string representation of a date value.
|
* Parses an ISO-8601 string representation of a date value.
|
||||||
*
|
|
||||||
* @param dateToConvert The date value as a string.
|
* @param dateToConvert The date value as a string.
|
||||||
* @returns The parsed date object.
|
* @returns The parsed date object.
|
||||||
*/
|
*/
|
||||||
@ -41,7 +40,6 @@ export class DateAlfresco extends Date {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Parses the date component of a ISO-8601 string representation of a date value.
|
* Parses the date component of a ISO-8601 string representation of a date value.
|
||||||
*
|
|
||||||
* @param dateToConvert The date value as a string.
|
* @param dateToConvert The date value as a string.
|
||||||
* @returns The parsed date object.
|
* @returns The parsed date object.
|
||||||
*/
|
*/
|
||||||
@ -50,7 +48,7 @@ export class DateAlfresco extends Date {
|
|||||||
// return new Date(str.replace(/T/i, ' '));
|
// return new Date(str.replace(/T/i, ' '));
|
||||||
|
|
||||||
// Compatible with Safari 9.1.2
|
// Compatible with Safari 9.1.2
|
||||||
const dateParts = dateToConvert.split(/[^0-9]/).map(function(s) {
|
const dateParts = dateToConvert.split(/[^0-9]/).map(function (s) {
|
||||||
return parseInt(s, 10);
|
return parseInt(s, 10);
|
||||||
});
|
});
|
||||||
return new Date(
|
return new Date(
|
||||||
@ -68,7 +66,6 @@ export class DateAlfresco extends Date {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Parses the timezone component of a ISO-8601 string representation of a date value.
|
* Parses the timezone component of a ISO-8601 string representation of a date value.
|
||||||
*
|
|
||||||
* @param dateToConvert The timezone offset as a string, e.g. '+0000', '+2000' or '-0500'.
|
* @param dateToConvert The timezone offset as a string, e.g. '+0000', '+2000' or '-0500'.
|
||||||
* @returns The number of minutes offset from UTC.
|
* @returns The number of minutes offset from UTC.
|
||||||
*/
|
*/
|
||||||
|
@ -29,7 +29,6 @@ export class ActionsApi extends BaseApi {
|
|||||||
* Retrieve the details of an action definition
|
* Retrieve the details of an action definition
|
||||||
*
|
*
|
||||||
* **Note:** this endpoint is available in Alfresco 5.2 and newer versions.
|
* **Note:** this endpoint is available in Alfresco 5.2 and newer versions.
|
||||||
*
|
|
||||||
* @param actionDefinitionId The identifier of an action definition.
|
* @param actionDefinitionId The identifier of an action definition.
|
||||||
* @returns Promise<ActionDefinitionEntry>
|
* @returns Promise<ActionDefinitionEntry>
|
||||||
*/
|
*/
|
||||||
@ -50,7 +49,6 @@ export class ActionsApi extends BaseApi {
|
|||||||
* Execute an action
|
* Execute an action
|
||||||
*
|
*
|
||||||
* **Note:** this endpoint is available in Alfresco 5.2 and newer versions.
|
* **Note:** this endpoint is available in Alfresco 5.2 and newer versions.
|
||||||
*
|
|
||||||
* @param actionBodyExec Action execution details
|
* @param actionBodyExec Action execution details
|
||||||
* @returns Promise<ActionExecResultEntry>
|
* @returns Promise<ActionExecResultEntry>
|
||||||
*/
|
*/
|
||||||
@ -76,8 +74,6 @@ export class ActionsApi extends BaseApi {
|
|||||||
* You can use any of the following fields to order the results:
|
* You can use any of the following fields to order the results:
|
||||||
* - name
|
* - name
|
||||||
* - title
|
* - title
|
||||||
*
|
|
||||||
*
|
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
* @param opts.orderBy A string to control the order of the entities returned in a list. You can use the **orderBy** parameter to
|
* @param opts.orderBy A string to control the order of the entities returned in a list. You can use the **orderBy** parameter to
|
||||||
* sort the list by one or more fields.
|
* sort the list by one or more fields.
|
||||||
@ -114,7 +110,6 @@ export class ActionsApi extends BaseApi {
|
|||||||
* You can use any of the following fields to order the results:
|
* You can use any of the following fields to order the results:
|
||||||
* - name
|
* - name
|
||||||
* - title
|
* - title
|
||||||
*
|
|
||||||
* @param nodeId The identifier of a node.
|
* @param nodeId The identifier of a node.
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
* @param opts.orderBy A string to control the order of the entities returned in a list. You can use the **orderBy** parameter to
|
* @param opts.orderBy A string to control the order of the entities returned in a list. You can use the **orderBy** parameter to
|
||||||
|
@ -30,7 +30,6 @@ export class ActivitiesApi extends BaseApi {
|
|||||||
*
|
*
|
||||||
* Gets a list of activities for person **personId**.
|
* Gets a list of activities for person **personId**.
|
||||||
* You can use the -me- string in place of <personId> to specify the currently authenticated user.
|
* You can use the -me- string in place of <personId> to specify the currently authenticated user.
|
||||||
*
|
|
||||||
* @param personId The identifier of a person.
|
* @param personId The identifier of a person.
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
* @param opts.who A filter to include the user's activities only me, other user's activities only others'
|
* @param opts.who A filter to include the user's activities only me, other user's activities only others'
|
||||||
|
@ -25,7 +25,6 @@ import { BaseApi } from '../../hxi-connector-api/api/base.api';
|
|||||||
export class AgentsApi extends BaseApi {
|
export class AgentsApi extends BaseApi {
|
||||||
/**
|
/**
|
||||||
* Gets all agents.
|
* Gets all agents.
|
||||||
*
|
|
||||||
* @returns AgentPaging object containing the agents.
|
* @returns AgentPaging object containing the agents.
|
||||||
*/
|
*/
|
||||||
getAgents(): Promise<AgentPaging> {
|
getAgents(): Promise<AgentPaging> {
|
||||||
|
@ -37,7 +37,6 @@ export class AuditApi extends BaseApi {
|
|||||||
* - where=(createdAt BETWEEN ('2017-06-02T12:13:51.593+01:00' , '2017-06-04T10:05:16.536+01:00')
|
* - where=(createdAt BETWEEN ('2017-06-02T12:13:51.593+01:00' , '2017-06-04T10:05:16.536+01:00')
|
||||||
* - where=(id BETWEEN ('1234', '4321')
|
* - where=(id BETWEEN ('1234', '4321')
|
||||||
* You must have admin rights to delete audit information.
|
* You must have admin rights to delete audit information.
|
||||||
*
|
|
||||||
* @param auditApplicationId The identifier of an audit application.
|
* @param auditApplicationId The identifier of an audit application.
|
||||||
* @param where Audit entries to permanently delete for an audit application, given an inclusive time period or range of ids. For example:
|
* @param where Audit entries to permanently delete for an audit application, given an inclusive time period or range of ids. For example:
|
||||||
* - where=(createdAt BETWEEN ('2017-06-02T12:13:51.593+01:00' , '2017-06-04T10:05:16.536+01:00')
|
* - where=(createdAt BETWEEN ('2017-06-02T12:13:51.593+01:00' , '2017-06-04T10:05:16.536+01:00')
|
||||||
@ -68,7 +67,6 @@ export class AuditApi extends BaseApi {
|
|||||||
*
|
*
|
||||||
* **Note:** this endpoint is available in Alfresco 5.2.2 and newer versions.
|
* **Note:** this endpoint is available in Alfresco 5.2.2 and newer versions.
|
||||||
* You must have admin rights to delete audit information.
|
* You must have admin rights to delete audit information.
|
||||||
*
|
|
||||||
* @param auditApplicationId The identifier of an audit application.
|
* @param auditApplicationId The identifier of an audit application.
|
||||||
* @param auditEntryId The identifier of an audit entry.
|
* @param auditEntryId The identifier of an audit entry.
|
||||||
* @return Promise<{}>
|
* @return Promise<{}>
|
||||||
@ -95,7 +93,6 @@ export class AuditApi extends BaseApi {
|
|||||||
* You must have admin rights to retrieve audit information.
|
* You must have admin rights to retrieve audit information.
|
||||||
*
|
*
|
||||||
* You can use the **include** parameter to return the minimum and/or maximum audit record id for the application.
|
* You can use the **include** parameter to return the minimum and/or maximum audit record id for the application.
|
||||||
*
|
|
||||||
* @param auditApplicationId The identifier of an audit application.
|
* @param auditApplicationId The identifier of an audit application.
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
* @return Promise<AuditApp>
|
* @return Promise<AuditApp>
|
||||||
@ -124,7 +121,6 @@ export class AuditApi extends BaseApi {
|
|||||||
*
|
*
|
||||||
* **Note:** this endpoint is available in Alfresco 5.2.2 and newer versions.
|
* **Note:** this endpoint is available in Alfresco 5.2.2 and newer versions.
|
||||||
* You must have admin rights to access audit information.
|
* You must have admin rights to access audit information.
|
||||||
*
|
|
||||||
* @param auditApplicationId The identifier of an audit application.
|
* @param auditApplicationId The identifier of an audit application.
|
||||||
* @param auditEntryId The identifier of an audit entry.
|
* @param auditEntryId The identifier of an audit entry.
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
@ -164,7 +160,6 @@ export class AuditApi extends BaseApi {
|
|||||||
* - Alfresco Sync Service (used by Enterprise Cloud Sync)
|
* - Alfresco Sync Service (used by Enterprise Cloud Sync)
|
||||||
*
|
*
|
||||||
* You must have admin rights to retrieve audit information.
|
* You must have admin rights to retrieve audit information.
|
||||||
*
|
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
* @return Promise<AuditAppPaging>
|
* @return Promise<AuditAppPaging>
|
||||||
*/
|
*/
|
||||||
@ -201,7 +196,6 @@ export class AuditApi extends BaseApi {
|
|||||||
*
|
*
|
||||||
* For example, specifying orderBy=createdAt DESC returns audit entries in descending **createdAt** order.
|
* For example, specifying orderBy=createdAt DESC returns audit entries in descending **createdAt** order.
|
||||||
* You must have admin rights to retrieve audit information.
|
* You must have admin rights to retrieve audit information.
|
||||||
*
|
|
||||||
* @param auditApplicationId The identifier of an audit application.
|
* @param auditApplicationId The identifier of an audit application.
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
* @param opts.orderBy A string to control the order of the entities returned in a list. You can use the **orderBy** parameter to
|
* @param opts.orderBy A string to control the order of the entities returned in a list. You can use the **orderBy** parameter to
|
||||||
@ -262,7 +256,6 @@ export class AuditApi extends BaseApi {
|
|||||||
*
|
*
|
||||||
* For example, specifying orderBy=createdAt DESC returns audit entries in descending **createdAt** order.
|
* For example, specifying orderBy=createdAt DESC returns audit entries in descending **createdAt** order.
|
||||||
* This relies on the pre-configured 'alfresco-access' audit application.
|
* This relies on the pre-configured 'alfresco-access' audit application.
|
||||||
*
|
|
||||||
* @param nodeId The identifier of a node.
|
* @param nodeId The identifier of a node.
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
* @param opts.orderBy A string to control the order of the entities returned in a list. You can use the **orderBy** parameter to
|
* @param opts.orderBy A string to control the order of the entities returned in a list. You can use the **orderBy** parameter to
|
||||||
@ -319,7 +312,6 @@ export class AuditApi extends BaseApi {
|
|||||||
* Note, it is still possible to query &/or delete any existing audit entries even
|
* Note, it is still possible to query &/or delete any existing audit entries even
|
||||||
* if auditing is disabled for the audit application.
|
* if auditing is disabled for the audit application.
|
||||||
* You must have admin rights to update audit application.
|
* You must have admin rights to update audit application.
|
||||||
*
|
|
||||||
* @param auditApplicationId The identifier of an audit application.
|
* @param auditApplicationId The identifier of an audit application.
|
||||||
* @param auditAppBodyUpdate The audit application to update.
|
* @param auditAppBodyUpdate The audit application to update.
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
|
@ -34,7 +34,6 @@ export class CategoriesApi extends BaseApi {
|
|||||||
* The parameter categoryId can be set to the alias -root- to obtain a list of top level categories.
|
* The parameter categoryId can be set to the alias -root- to obtain a list of top level categories.
|
||||||
*
|
*
|
||||||
* You can use the **include** parameter to return additional **values** information.
|
* You can use the **include** parameter to return additional **values** information.
|
||||||
*
|
|
||||||
* @param categoryId The identifier of a category.
|
* @param categoryId The identifier of a category.
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
* @returns Promise<CategoryPaging>
|
* @returns Promise<CategoryPaging>
|
||||||
@ -66,7 +65,6 @@ export class CategoriesApi extends BaseApi {
|
|||||||
*
|
*
|
||||||
* Get a specific category with categoryId.
|
* Get a specific category with categoryId.
|
||||||
* You can use the **include** parameter to return additional **values** information.
|
* You can use the **include** parameter to return additional **values** information.
|
||||||
*
|
|
||||||
* @param categoryId The identifier of a category.
|
* @param categoryId The identifier of a category.
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
* @returns Promise<CategoryEntry>
|
* @returns Promise<CategoryEntry>
|
||||||
@ -93,7 +91,6 @@ export class CategoriesApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* List of categories that node is assigned to
|
* List of categories that node is assigned to
|
||||||
*
|
|
||||||
* @param nodeId The identifier of a node.
|
* @param nodeId The identifier of a node.
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
* @returns Promise<CategoryPaging>
|
* @returns Promise<CategoryPaging>
|
||||||
@ -125,7 +122,6 @@ export class CategoriesApi extends BaseApi {
|
|||||||
*
|
*
|
||||||
* This will cause everything to be removed from the category.
|
* This will cause everything to be removed from the category.
|
||||||
* You must have admin rights to delete a category.
|
* You must have admin rights to delete a category.
|
||||||
*
|
|
||||||
* @param categoryId The identifier of a category.
|
* @param categoryId The identifier of a category.
|
||||||
* @returns Promise<{}>
|
* @returns Promise<{}>
|
||||||
*/
|
*/
|
||||||
@ -144,7 +140,6 @@ export class CategoriesApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Unassign a node from category
|
* Unassign a node from category
|
||||||
*
|
|
||||||
* @param nodeId The identifier of a node.
|
* @param nodeId The identifier of a node.
|
||||||
* @param categoryId The identifier of a category.
|
* @param categoryId The identifier of a category.
|
||||||
* @returns Promise<{}>
|
* @returns Promise<{}>
|
||||||
@ -169,7 +164,6 @@ export class CategoriesApi extends BaseApi {
|
|||||||
*
|
*
|
||||||
* Updates the category **categoryId**.
|
* Updates the category **categoryId**.
|
||||||
* You must have admin rights to update a category.
|
* You must have admin rights to update a category.
|
||||||
*
|
|
||||||
* @param categoryId The identifier of a category.
|
* @param categoryId The identifier of a category.
|
||||||
* @param categoryBodyUpdate The updated category
|
* @param categoryBodyUpdate The updated category
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
@ -203,7 +197,6 @@ export class CategoriesApi extends BaseApi {
|
|||||||
* Creates new categories within the category **categoryId**.
|
* Creates new categories within the category **categoryId**.
|
||||||
* The parameter categoryId can be set to the alias -root- to create a new top level category.
|
* The parameter categoryId can be set to the alias -root- to create a new top level category.
|
||||||
* You must have admin rights to create a category.
|
* You must have admin rights to create a category.
|
||||||
*
|
|
||||||
* @param categoryId The identifier of a category.
|
* @param categoryId The identifier of a category.
|
||||||
* @param categoryBodyCreate List of categories to create.
|
* @param categoryBodyCreate List of categories to create.
|
||||||
* @param opts Optional parameters.
|
* @param opts Optional parameters.
|
||||||
@ -233,7 +226,6 @@ export class CategoriesApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Assign a node to a category
|
* Assign a node to a category
|
||||||
*
|
|
||||||
* @param nodeId The identifier of a node.
|
* @param nodeId The identifier of a node.
|
||||||
* @param categoryLinkBodyCreate The new category link
|
* @param categoryLinkBodyCreate The new category link
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
|
@ -29,7 +29,6 @@ import { ContentFieldsQuery, ContentPagingQuery } from './types';
|
|||||||
export class CommentsApi extends BaseApi {
|
export class CommentsApi extends BaseApi {
|
||||||
/**
|
/**
|
||||||
* Create a comment
|
* Create a comment
|
||||||
*
|
|
||||||
* @param nodeId The identifier of a node.
|
* @param nodeId The identifier of a node.
|
||||||
* @param commentBodyCreate The comment text. Note that you can also provide a list of comments.
|
* @param commentBodyCreate The comment text. Note that you can also provide a list of comments.
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
@ -58,7 +57,6 @@ export class CommentsApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Delete a comment
|
* Delete a comment
|
||||||
*
|
|
||||||
* @param nodeId The identifier of a node.
|
* @param nodeId The identifier of a node.
|
||||||
* @param commentId The identifier of a comment.
|
* @param commentId The identifier of a comment.
|
||||||
* @returns Promise<{}>
|
* @returns Promise<{}>
|
||||||
@ -82,7 +80,6 @@ export class CommentsApi extends BaseApi {
|
|||||||
* List comments
|
* List comments
|
||||||
*
|
*
|
||||||
* Gets a list of comments for the node **nodeId**, sorted chronologically with the newest comment first.
|
* Gets a list of comments for the node **nodeId**, sorted chronologically with the newest comment first.
|
||||||
*
|
|
||||||
* @param nodeId The identifier of a node.
|
* @param nodeId The identifier of a node.
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
* @returns Promise<CommentPaging>
|
* @returns Promise<CommentPaging>
|
||||||
@ -110,7 +107,6 @@ export class CommentsApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Update a comment
|
* Update a comment
|
||||||
*
|
|
||||||
* @param nodeId The identifier of a node.
|
* @param nodeId The identifier of a node.
|
||||||
* @param commentId The identifier of a comment.
|
* @param commentId The identifier of a comment.
|
||||||
* @param commentBodyUpdate The JSON representing the comment to be updated.
|
* @param commentBodyUpdate The JSON representing the comment to be updated.
|
||||||
|
@ -36,7 +36,6 @@ export class DownloadsApi extends BaseApi {
|
|||||||
* By default, if the download node is not deleted it will be picked up by a cleaner job which removes download nodes older than a configurable amount of time (default is 1 hour)
|
* By default, if the download node is not deleted it will be picked up by a cleaner job which removes download nodes older than a configurable amount of time (default is 1 hour)
|
||||||
* Information about the existing progress at the time of cancelling can be retrieved by calling the **GET /downloads/{downloadId}** endpoint
|
* Information about the existing progress at the time of cancelling can be retrieved by calling the **GET /downloads/{downloadId}** endpoint
|
||||||
* The cancel operation is done asynchronously.
|
* The cancel operation is done asynchronously.
|
||||||
*
|
|
||||||
* @param downloadId The identifier of a download node.
|
* @param downloadId The identifier of a download node.
|
||||||
* @returns Promise<{}>
|
* @returns Promise<{}>
|
||||||
*/
|
*/
|
||||||
@ -58,7 +57,6 @@ export class DownloadsApi extends BaseApi {
|
|||||||
*
|
*
|
||||||
* **Note:** this endpoint is available in Alfresco 5.2.1 and newer versions.
|
* **Note:** this endpoint is available in Alfresco 5.2.1 and newer versions.
|
||||||
* **Note:** The content of the download node can be obtained using the **GET /nodes/{downloadId}/content** endpoint
|
* **Note:** The content of the download node can be obtained using the **GET /nodes/{downloadId}/content** endpoint
|
||||||
*
|
|
||||||
* @param downloadBodyCreate The nodeIds the content of which will be zipped, which zip will be set as the content of our download node.
|
* @param downloadBodyCreate The nodeIds the content of which will be zipped, which zip will be set as the content of our download node.
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
* @param opts.fields A list of field names. You can use this parameter to restrict the fields
|
* @param opts.fields A list of field names. You can use this parameter to restrict the fields
|
||||||
@ -86,7 +84,6 @@ export class DownloadsApi extends BaseApi {
|
|||||||
* Get a download
|
* Get a download
|
||||||
*
|
*
|
||||||
* **Note:** this endpoint is available in Alfresco 5.2.1 and newer versions.
|
* **Note:** this endpoint is available in Alfresco 5.2.1 and newer versions.
|
||||||
*
|
|
||||||
* @param downloadId The identifier of a download node.
|
* @param downloadId The identifier of a download node.
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
* @param opts.fields A list of field names. You can use this parameter to restrict the fields
|
* @param opts.fields A list of field names. You can use this parameter to restrict the fields
|
||||||
|
@ -30,7 +30,6 @@ export class FavoritesApi extends BaseApi {
|
|||||||
*
|
*
|
||||||
* Favorite a **site**, **file**, or **folder** in the repository.
|
* Favorite a **site**, **file**, or **folder** in the repository.
|
||||||
* You can use the -me- string in place of <personId> to specify the currently authenticated user.
|
* You can use the -me- string in place of <personId> to specify the currently authenticated user.
|
||||||
*
|
|
||||||
* @param personId The identifier of a person.
|
* @param personId The identifier of a person.
|
||||||
* @param favoriteBodyCreate An object identifying the entity to be favorited.
|
* @param favoriteBodyCreate An object identifying the entity to be favorited.
|
||||||
* The object consists of a single property which is an object with the name site, file, or folder.
|
* The object consists of a single property which is an object with the name site, file, or folder.
|
||||||
@ -76,7 +75,6 @@ export class FavoritesApi extends BaseApi {
|
|||||||
* Create a site favorite
|
* Create a site favorite
|
||||||
*
|
*
|
||||||
* **Note:** this endpoint is deprecated as of Alfresco 4.2, and will be removed in the future. Use /people/{personId}/favorites instead.
|
* **Note:** this endpoint is deprecated as of Alfresco 4.2, and will be removed in the future. Use /people/{personId}/favorites instead.
|
||||||
*
|
|
||||||
* @param personId The identifier of a person.
|
* @param personId The identifier of a person.
|
||||||
* @param favoriteSiteBodyCreate The id of the site to favorite.
|
* @param favoriteSiteBodyCreate The id of the site to favorite.
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
@ -106,7 +104,6 @@ export class FavoritesApi extends BaseApi {
|
|||||||
* Delete a favorite
|
* Delete a favorite
|
||||||
*
|
*
|
||||||
* You can use the -me- string in place of <personId> to specify the currently authenticated user.
|
* You can use the -me- string in place of <personId> to specify the currently authenticated user.
|
||||||
*
|
|
||||||
* @param personId The identifier of a person.
|
* @param personId The identifier of a person.
|
||||||
* @param favoriteId The identifier of a favorite.
|
* @param favoriteId The identifier of a favorite.
|
||||||
* @returns Promise<{}>
|
* @returns Promise<{}>
|
||||||
@ -133,7 +130,6 @@ export class FavoritesApi extends BaseApi {
|
|||||||
* Use /people/{personId}/favorites/{favoriteId} instead.
|
* Use /people/{personId}/favorites/{favoriteId} instead.
|
||||||
*
|
*
|
||||||
* You can use the -me- string in place of <personId> to specify the currently authenticated user.
|
* You can use the -me- string in place of <personId> to specify the currently authenticated user.
|
||||||
*
|
|
||||||
* @param personId The identifier of a person.
|
* @param personId The identifier of a person.
|
||||||
* @param siteId The identifier of a site.
|
* @param siteId The identifier of a site.
|
||||||
* @returns Promise<{}>
|
* @returns Promise<{}>
|
||||||
@ -158,7 +154,6 @@ export class FavoritesApi extends BaseApi {
|
|||||||
*
|
*
|
||||||
* Gets favorite **favoriteId** for person **personId**.
|
* Gets favorite **favoriteId** for person **personId**.
|
||||||
* You can use the -me- string in place of <personId> to specify the currently authenticated user.
|
* You can use the -me- string in place of <personId> to specify the currently authenticated user.
|
||||||
*
|
|
||||||
* @param personId The identifier of a person.
|
* @param personId The identifier of a person.
|
||||||
* @param favoriteId The identifier of a favorite.
|
* @param favoriteId The identifier of a favorite.
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
@ -201,7 +196,6 @@ export class FavoritesApi extends BaseApi {
|
|||||||
* Use /people/{personId}/favorites/{favoriteId} instead.
|
* Use /people/{personId}/favorites/{favoriteId} instead.
|
||||||
*
|
*
|
||||||
* You can use the -me- string in place of <personId> to specify the currently authenticated user.
|
* You can use the -me- string in place of <personId> to specify the currently authenticated user.
|
||||||
*
|
|
||||||
* @param personId The identifier of a person.
|
* @param personId The identifier of a person.
|
||||||
* @param siteId The identifier of a site.
|
* @param siteId The identifier of a site.
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
@ -240,7 +234,6 @@ export class FavoritesApi extends BaseApi {
|
|||||||
* Use /people/{personId}/favorites instead.
|
* Use /people/{personId}/favorites instead.
|
||||||
*
|
*
|
||||||
* You can use the -me- string in place of <personId> to specify the currently authenticated user.
|
* You can use the -me- string in place of <personId> to specify the currently authenticated user.
|
||||||
*
|
|
||||||
* @param personId The identifier of a person.
|
* @param personId The identifier of a person.
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
* @returns Promise<SitePaging>
|
* @returns Promise<SitePaging>
|
||||||
@ -271,7 +264,6 @@ export class FavoritesApi extends BaseApi {
|
|||||||
*
|
*
|
||||||
* Gets a list of favorites for person **personId**.
|
* Gets a list of favorites for person **personId**.
|
||||||
* You can use the -me- string in place of <personId> to specify the currently authenticated user.
|
* You can use the -me- string in place of <personId> to specify the currently authenticated user.
|
||||||
*
|
|
||||||
* @param personId The identifier of a person.
|
* @param personId The identifier of a person.
|
||||||
* @param opts optional parameters
|
* @param opts optional parameters
|
||||||
* @returns Promise<FavoritePaging>
|
* @returns Promise<FavoritePaging>
|
||||||
|
@ -75,7 +75,6 @@ export class GroupsApi extends BaseApi {
|
|||||||
* The group will be created in the **APP.DEFAULT** and **AUTH.ALF** zones.
|
* The group will be created in the **APP.DEFAULT** and **AUTH.ALF** zones.
|
||||||
*
|
*
|
||||||
* You must have admin rights to create a group.
|
* You must have admin rights to create a group.
|
||||||
*
|
|
||||||
* @param groupBodyCreate The group to create.
|
* @param groupBodyCreate The group to create.
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
* @returns Promise<GroupEntry>
|
* @returns Promise<GroupEntry>
|
||||||
@ -104,7 +103,6 @@ export class GroupsApi extends BaseApi {
|
|||||||
* If the added group was previously a root group then it becomes a non-root group since it now has a parent.
|
* If the added group was previously a root group then it becomes a non-root group since it now has a parent.
|
||||||
* It is an error to specify an **id** that does not exist.
|
* It is an error to specify an **id** that does not exist.
|
||||||
* You must have admin rights to create a group membership.
|
* You must have admin rights to create a group membership.
|
||||||
*
|
|
||||||
* @param groupId The identifier of a group.
|
* @param groupId The identifier of a group.
|
||||||
* @param groupMembershipBodyCreate The group membership to add (person or sub-group).
|
* @param groupMembershipBodyCreate The group membership to add (person or sub-group).
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
@ -140,7 +138,6 @@ export class GroupsApi extends BaseApi {
|
|||||||
* In this case, removing a group member does not delete the person or sub-group itself.
|
* In this case, removing a group member does not delete the person or sub-group itself.
|
||||||
* If a removed sub-group no longer has any parent groups then it becomes a root group.
|
* If a removed sub-group no longer has any parent groups then it becomes a root group.
|
||||||
* You must have admin rights to delete a group.
|
* You must have admin rights to delete a group.
|
||||||
*
|
|
||||||
* @param groupId The identifier of a group.
|
* @param groupId The identifier of a group.
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
* @returns Promise
|
* @returns Promise
|
||||||
@ -174,7 +171,6 @@ export class GroupsApi extends BaseApi {
|
|||||||
* Delete group member **groupMemberId** (person or sub-group) from group **groupId**.
|
* Delete group member **groupMemberId** (person or sub-group) from group **groupId**.
|
||||||
* Removing a group member does not delete the person or sub-group itself.\
|
* Removing a group member does not delete the person or sub-group itself.\
|
||||||
* If a removed sub-group no longer has any parent groups then it becomes a root group.
|
* If a removed sub-group no longer has any parent groups then it becomes a root group.
|
||||||
*
|
|
||||||
* @param groupId The identifier of a group.
|
* @param groupId The identifier of a group.
|
||||||
* @param groupMemberId The identifier of a person or group.
|
* @param groupMemberId The identifier of a person or group.
|
||||||
* @returns Promise<{}>
|
* @returns Promise<{}>
|
||||||
@ -201,7 +197,6 @@ export class GroupsApi extends BaseApi {
|
|||||||
*
|
*
|
||||||
* Get details for group **groupId**.
|
* Get details for group **groupId**.
|
||||||
* You can use the **include** parameter to return additional information.
|
* You can use the **include** parameter to return additional information.
|
||||||
*
|
|
||||||
* @param groupId The identifier of a group.
|
* @param groupId The identifier of a group.
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
* @returns Promise<GroupEntry>
|
* @returns Promise<GroupEntry>
|
||||||
@ -241,7 +236,6 @@ export class GroupsApi extends BaseApi {
|
|||||||
* You can override the default by using the **orderBy** parameter. You can specify one of the following fields in the **orderBy** parameter:
|
* You can override the default by using the **orderBy** parameter. You can specify one of the following fields in the **orderBy** parameter:
|
||||||
* - id
|
* - id
|
||||||
* - displayName
|
* - displayName
|
||||||
*
|
|
||||||
* @param groupId The identifier of a group.
|
* @param groupId The identifier of a group.
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
* @returns Promise<GroupMemberPaging>
|
* @returns Promise<GroupMemberPaging>
|
||||||
@ -273,7 +267,6 @@ export class GroupsApi extends BaseApi {
|
|||||||
* List group memberships
|
* List group memberships
|
||||||
*
|
*
|
||||||
* **Note:** this endpoint is available in Alfresco 5.2.1 and newer versions.
|
* **Note:** this endpoint is available in Alfresco 5.2.1 and newer versions.
|
||||||
*
|
|
||||||
* @param personId The identifier of a person.
|
* @param personId The identifier of a person.
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
* @param opts.skipCount The number of entities that exist in the collection before those included in this list.
|
* @param opts.skipCount The number of entities that exist in the collection before those included in this list.
|
||||||
@ -327,7 +320,6 @@ export class GroupsApi extends BaseApi {
|
|||||||
* List groups
|
* List groups
|
||||||
*
|
*
|
||||||
* **Note:** this endpoint is available in Alfresco 5.2.1 and newer versions.
|
* **Note:** this endpoint is available in Alfresco 5.2.1 and newer versions.
|
||||||
*
|
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
* @returns Promise<GroupPaging>
|
* @returns Promise<GroupPaging>
|
||||||
*/
|
*/
|
||||||
@ -353,7 +345,6 @@ export class GroupsApi extends BaseApi {
|
|||||||
*
|
*
|
||||||
* **Note:** this endpoint is available in Alfresco 5.2.1 and newer versions.
|
* **Note:** this endpoint is available in Alfresco 5.2.1 and newer versions.
|
||||||
* You must have admin rights to update a group.
|
* You must have admin rights to update a group.
|
||||||
*
|
|
||||||
* @param groupId The identifier of a group.
|
* @param groupId The identifier of a group.
|
||||||
* @param groupBodyUpdate The group information to update.
|
* @param groupBodyUpdate The group information to update.
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
|
@ -28,7 +28,6 @@ import { ContentFieldsQuery, ContentPagingQuery } from './types';
|
|||||||
export class NetworksApi extends BaseApi {
|
export class NetworksApi extends BaseApi {
|
||||||
/**
|
/**
|
||||||
* Get a network
|
* Get a network
|
||||||
*
|
|
||||||
* @param networkId The identifier of a network.
|
* @param networkId The identifier of a network.
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
* @returns Promise<PersonNetworkEntry>
|
* @returns Promise<PersonNetworkEntry>
|
||||||
@ -56,7 +55,6 @@ export class NetworksApi extends BaseApi {
|
|||||||
* Get network information
|
* Get network information
|
||||||
*
|
*
|
||||||
* You can use the -me- string in place of <personId> to specify the currently authenticated user.
|
* You can use the -me- string in place of <personId> to specify the currently authenticated user.
|
||||||
*
|
|
||||||
* @param personId The identifier of a person.
|
* @param personId The identifier of a person.
|
||||||
* @param networkId The identifier of a network.
|
* @param networkId The identifier of a network.
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
@ -88,7 +86,6 @@ export class NetworksApi extends BaseApi {
|
|||||||
*
|
*
|
||||||
* Gets a list of network memberships for person **personId**.
|
* Gets a list of network memberships for person **personId**.
|
||||||
* You can use the -me- string in place of <personId> to specify the currently authenticated user.
|
* You can use the -me- string in place of <personId> to specify the currently authenticated user.
|
||||||
*
|
|
||||||
* @param personId The identifier of a person.
|
* @param personId The identifier of a person.
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
* @returns Promise<PersonNetworkPaging>
|
* @returns Promise<PersonNetworkPaging>
|
||||||
|
@ -91,7 +91,6 @@ export class NodesApi extends BaseApi {
|
|||||||
* If the source **nodeId** is a folder, then all of its children are also copied.
|
* If the source **nodeId** is a folder, then all of its children are also copied.
|
||||||
*
|
*
|
||||||
* If the source **nodeId** is a file, it's properties, aspects and tags are copied, it's ratings, comments and locks are not.
|
* If the source **nodeId** is a file, it's properties, aspects and tags are copied, it's ratings, comments and locks are not.
|
||||||
*
|
|
||||||
* @param nodeId The identifier of a node.
|
* @param nodeId The identifier of a node.
|
||||||
* @param nodeBodyCopy The targetParentId and, optionally, a new name which should include the file extension.
|
* @param nodeBodyCopy The targetParentId and, optionally, a new name which should include the file extension.
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
@ -123,7 +122,6 @@ export class NodesApi extends BaseApi {
|
|||||||
* Create node association
|
* Create node association
|
||||||
*
|
*
|
||||||
* **Note:** this endpoint is available in Alfresco 5.2 and newer versions.
|
* **Note:** this endpoint is available in Alfresco 5.2 and newer versions.
|
||||||
*
|
|
||||||
* @param nodeId The identifier of a source node.
|
* @param nodeId The identifier of a source node.
|
||||||
* @param associationBodyCreate The target node id and assoc type.
|
* @param associationBodyCreate The target node id and assoc type.
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
@ -159,7 +157,6 @@ export class NodesApi extends BaseApi {
|
|||||||
* Create a node
|
* Create a node
|
||||||
*
|
*
|
||||||
* **Note:** this endpoint is available in Alfresco 5.2 and newer versions.
|
* **Note:** this endpoint is available in Alfresco 5.2 and newer versions.
|
||||||
*
|
|
||||||
* @param nodeId The identifier of a node. You can also use one of these well-known aliases:
|
* @param nodeId The identifier of a node. You can also use one of these well-known aliases:
|
||||||
* -my-
|
* -my-
|
||||||
* -shared-
|
* -shared-
|
||||||
@ -223,7 +220,6 @@ export class NodesApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Create a folder
|
* Create a folder
|
||||||
*
|
|
||||||
* @param name - folder name
|
* @param name - folder name
|
||||||
* @param relativePath - The relativePath specifies the folder structure to create relative to the node identified by nodeId.
|
* @param relativePath - The relativePath specifies the folder structure to create relative to the node identified by nodeId.
|
||||||
* @param nodeId default value root.The identifier of a node where add the folder. You can also use one of these well-known aliases: -my- | -shared- | -root-
|
* @param nodeId default value root.The identifier of a node where add the folder. You can also use one of these well-known aliases: -my- | -shared- | -root-
|
||||||
@ -246,7 +242,6 @@ export class NodesApi extends BaseApi {
|
|||||||
* Create secondary child
|
* Create secondary child
|
||||||
*
|
*
|
||||||
* **Note:** this endpoint is available in Alfresco 5.2 and newer versions.
|
* **Note:** this endpoint is available in Alfresco 5.2 and newer versions.
|
||||||
*
|
|
||||||
* @param nodeId The identifier of a parent node.
|
* @param nodeId The identifier of a parent node.
|
||||||
* @param secondaryChildAssociationBodyCreate The child node id and assoc type.
|
* @param secondaryChildAssociationBodyCreate The child node id and assoc type.
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
@ -292,7 +287,6 @@ export class NodesApi extends BaseApi {
|
|||||||
* If the association type is **not** specified, then all peer associations, of any type, in the direction
|
* If the association type is **not** specified, then all peer associations, of any type, in the direction
|
||||||
* from source to target, are deleted.
|
* from source to target, are deleted.
|
||||||
* **Note:** After removal of the peer association, or associations, from source to target, the two nodes may still have peer associations in the other direction.
|
* **Note:** After removal of the peer association, or associations, from source to target, the two nodes may still have peer associations in the other direction.
|
||||||
*
|
|
||||||
* @param nodeId The identifier of a source node.
|
* @param nodeId The identifier of a source node.
|
||||||
* @param targetId The identifier of a target node.
|
* @param targetId The identifier of a target node.
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
@ -333,7 +327,6 @@ export class NodesApi extends BaseApi {
|
|||||||
* child association is restored. This applies recursively for any primary children. No other secondary child associations or
|
* child association is restored. This applies recursively for any primary children. No other secondary child associations or
|
||||||
* peer associations are restored for any of the nodes in the primary parent-child hierarchy of restored nodes, regardless of whether the original
|
* peer associations are restored for any of the nodes in the primary parent-child hierarchy of restored nodes, regardless of whether the original
|
||||||
* associations were to nodes inside or outside the restored hierarchy.
|
* associations were to nodes inside or outside the restored hierarchy.
|
||||||
*
|
|
||||||
* @param nodeId The identifier of a node.
|
* @param nodeId The identifier of a node.
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
* @param opts.permanent If **true** then the node is deleted permanently, without moving to the trashcan.
|
* @param opts.permanent If **true** then the node is deleted permanently, without moving to the trashcan.
|
||||||
@ -359,7 +352,6 @@ export class NodesApi extends BaseApi {
|
|||||||
}
|
}
|
||||||
/**
|
/**
|
||||||
* Delete multiple nodes
|
* Delete multiple nodes
|
||||||
*
|
|
||||||
* @param nodeIds The list of node IDs to delete.
|
* @param nodeIds The list of node IDs to delete.
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
* @param opts.permanent If **true** then nodes are deleted permanently, without moving to the trashcan.
|
* @param opts.permanent If **true** then nodes are deleted permanently, without moving to the trashcan.
|
||||||
@ -388,7 +380,6 @@ export class NodesApi extends BaseApi {
|
|||||||
* If the association type is **not** specified, then all secondary child associations, of any type in the direction
|
* If the association type is **not** specified, then all secondary child associations, of any type in the direction
|
||||||
* from parent to secondary child, will be deleted. The child will still have a primary parent and may still be
|
* from parent to secondary child, will be deleted. The child will still have a primary parent and may still be
|
||||||
* associated as a secondary child with other secondary parents.
|
* associated as a secondary child with other secondary parents.
|
||||||
*
|
|
||||||
* @param nodeId The identifier of a parent node.
|
* @param nodeId The identifier of a parent node.
|
||||||
* @param childId The identifier of a child node.
|
* @param childId The identifier of a child node.
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
@ -417,7 +408,6 @@ export class NodesApi extends BaseApi {
|
|||||||
* **Note:** this endpoint is available in Alfresco 5.2 and newer versions.
|
* **Note:** this endpoint is available in Alfresco 5.2 and newer versions.
|
||||||
*
|
*
|
||||||
* You can use the **include** parameter to return additional information.
|
* You can use the **include** parameter to return additional information.
|
||||||
*
|
|
||||||
* @param nodeId The identifier of a node. You can also use one of these well-known aliases:
|
* @param nodeId The identifier of a node. You can also use one of these well-known aliases:
|
||||||
* - -my-
|
* - -my-
|
||||||
* - -shared-
|
* - -shared-
|
||||||
@ -451,7 +441,6 @@ export class NodesApi extends BaseApi {
|
|||||||
* Get node content
|
* Get node content
|
||||||
*
|
*
|
||||||
* **Note:** this endpoint is available in Alfresco 5.2 and newer versions.
|
* **Note:** this endpoint is available in Alfresco 5.2 and newer versions.
|
||||||
*
|
|
||||||
* @param nodeId The identifier of a node.
|
* @param nodeId The identifier of a node.
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
* @param opts.attachment **true** enables a web browser to download the file as an attachment.
|
* @param opts.attachment **true** enables a web browser to download the file as an attachment.
|
||||||
@ -536,7 +525,6 @@ export class NodesApi extends BaseApi {
|
|||||||
* - createdAt
|
* - createdAt
|
||||||
* - modifiedByUser
|
* - modifiedByUser
|
||||||
* - createdByUser
|
* - createdByUser
|
||||||
*
|
|
||||||
* @param nodeId The identifier of a node. You can also use one of these well-known aliases:
|
* @param nodeId The identifier of a node. You can also use one of these well-known aliases:
|
||||||
* - -my-
|
* - -my-
|
||||||
* - -shared-
|
* - -shared-
|
||||||
@ -600,7 +588,6 @@ export class NodesApi extends BaseApi {
|
|||||||
*
|
*
|
||||||
* Gets a list of parent nodes that are associated with the current child **nodeId**.
|
* Gets a list of parent nodes that are associated with the current child **nodeId**.
|
||||||
* The list includes both the primary parent and any secondary parents.
|
* The list includes both the primary parent and any secondary parents.
|
||||||
*
|
|
||||||
* @param nodeId The identifier of a child node. You can also use one of these well-known aliases:
|
* @param nodeId The identifier of a child node. You can also use one of these well-known aliases:
|
||||||
* - -my-
|
* - -my-
|
||||||
* - -shared-
|
* - -shared-
|
||||||
@ -651,7 +638,6 @@ export class NodesApi extends BaseApi {
|
|||||||
* **Note:** this endpoint is available in Alfresco 5.2 and newer versions.
|
* **Note:** this endpoint is available in Alfresco 5.2 and newer versions.
|
||||||
*
|
*
|
||||||
* Gets a list of secondary child nodes that are associated with the current parent **nodeId**, via a secondary child association.
|
* Gets a list of secondary child nodes that are associated with the current parent **nodeId**, via a secondary child association.
|
||||||
*
|
|
||||||
* @param nodeId The identifier of a parent node. You can also use one of these well-known aliases:
|
* @param nodeId The identifier of a parent node. You can also use one of these well-known aliases:
|
||||||
* -my-
|
* -my-
|
||||||
* -shared-
|
* -shared-
|
||||||
@ -698,7 +684,6 @@ export class NodesApi extends BaseApi {
|
|||||||
* List source associations
|
* List source associations
|
||||||
*
|
*
|
||||||
* **Note:** this endpoint is available in Alfresco 5.2 and newer versions.
|
* **Note:** this endpoint is available in Alfresco 5.2 and newer versions.
|
||||||
*
|
|
||||||
* @param nodeId The identifier of a target node.
|
* @param nodeId The identifier of a target node.
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
* @param opts.where Optionally filter the list by **assocType**. Here's an example:
|
* @param opts.where Optionally filter the list by **assocType**. Here's an example:
|
||||||
@ -738,7 +723,6 @@ export class NodesApi extends BaseApi {
|
|||||||
* **Note:** this endpoint is available in Alfresco 5.2 and newer versions.
|
* **Note:** this endpoint is available in Alfresco 5.2 and newer versions.
|
||||||
*
|
*
|
||||||
* Gets a list of target nodes that are associated with the current source **nodeId**.
|
* Gets a list of target nodes that are associated with the current source **nodeId**.
|
||||||
*
|
|
||||||
* @param nodeId The identifier of a source node.
|
* @param nodeId The identifier of a source node.
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
* @param opts.where Optionally filter the list by **assocType**. Here's an example:
|
* @param opts.where Optionally filter the list by **assocType**. Here's an example:
|
||||||
@ -781,7 +765,6 @@ export class NodesApi extends BaseApi {
|
|||||||
* **Note:** this endpoint is available in Alfresco 5.2 and newer versions.
|
* **Note:** this endpoint is available in Alfresco 5.2 and newer versions.
|
||||||
*
|
*
|
||||||
* If a lock on the node cannot be taken, then an error is returned.
|
* If a lock on the node cannot be taken, then an error is returned.
|
||||||
*
|
|
||||||
* @param nodeId The identifier of a node.
|
* @param nodeId The identifier of a node.
|
||||||
* @param nodeBodyLock Lock details.
|
* @param nodeBodyLock Lock details.
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
@ -818,7 +801,6 @@ export class NodesApi extends BaseApi {
|
|||||||
* The moved node retains its name unless you specify a new **name** in the request body.
|
* The moved node retains its name unless you specify a new **name** in the request body.
|
||||||
* If the source **nodeId** is a folder, then its children are also moved.
|
* If the source **nodeId** is a folder, then its children are also moved.
|
||||||
* The move will effectively change the primary parent.
|
* The move will effectively change the primary parent.
|
||||||
*
|
|
||||||
* @param nodeId The identifier of a node.
|
* @param nodeId The identifier of a node.
|
||||||
* @param nodeBodyMove The targetParentId and, optionally, a new name which should include the file extension.
|
* @param nodeBodyMove The targetParentId and, optionally, a new name which should include the file extension.
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
@ -853,7 +835,6 @@ export class NodesApi extends BaseApi {
|
|||||||
*
|
*
|
||||||
* The current user must be the owner of the locks or have admin rights, otherwise an error is returned.
|
* The current user must be the owner of the locks or have admin rights, otherwise an error is returned.
|
||||||
* If a lock on the node cannot be released, then an error is returned.
|
* If a lock on the node cannot be released, then an error is returned.
|
||||||
*
|
|
||||||
* @param nodeId The identifier of a node.
|
* @param nodeId The identifier of a node.
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
* @returns Promise<NodeEntry>
|
* @returns Promise<NodeEntry>
|
||||||
@ -882,7 +863,6 @@ export class NodesApi extends BaseApi {
|
|||||||
* Update a node
|
* Update a node
|
||||||
*
|
*
|
||||||
* **Note:** this endpoint is available in Alfresco 5.2 and newer versions.
|
* **Note:** this endpoint is available in Alfresco 5.2 and newer versions.
|
||||||
*
|
|
||||||
* @param nodeId The identifier of a node.
|
* @param nodeId The identifier of a node.
|
||||||
* @param nodeBodyUpdate The node information to update.
|
* @param nodeBodyUpdate The node information to update.
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
@ -913,7 +893,6 @@ export class NodesApi extends BaseApi {
|
|||||||
* Update node content
|
* Update node content
|
||||||
*
|
*
|
||||||
* **Note:** this endpoint is available in Alfresco 5.2 and newer versions.
|
* **Note:** this endpoint is available in Alfresco 5.2 and newer versions.
|
||||||
*
|
|
||||||
* @param nodeId The identifier of a node.
|
* @param nodeId The identifier of a node.
|
||||||
* @param contentBodyUpdate The binary content
|
* @param contentBodyUpdate The binary content
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
@ -965,7 +944,6 @@ export class NodesApi extends BaseApi {
|
|||||||
* Generate a direct access content url for a given node
|
* Generate a direct access content url for a given node
|
||||||
*
|
*
|
||||||
* **Note:** this endpoint is available in Alfresco 7.1 and newer versions.
|
* **Note:** this endpoint is available in Alfresco 7.1 and newer versions.
|
||||||
*
|
|
||||||
* @param nodeId The identifier of a node.
|
* @param nodeId The identifier of a node.
|
||||||
* @returns Promise<DirectAccessUrlEntry>
|
* @returns Promise<DirectAccessUrlEntry>
|
||||||
*/
|
*/
|
||||||
|
@ -30,7 +30,6 @@ export class PeopleApi extends BaseApi {
|
|||||||
*
|
*
|
||||||
* **Note:** this endpoint is available in Alfresco 5.2 and newer versions.
|
* **Note:** this endpoint is available in Alfresco 5.2 and newer versions.
|
||||||
* **Note:** setting properties of type d:content and d:category are not supported.
|
* **Note:** setting properties of type d:content and d:category are not supported.
|
||||||
*
|
|
||||||
* @param personBodyCreate The person details.
|
* @param personBodyCreate The person details.
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
* @returns Promise<PersonEntry>
|
* @returns Promise<PersonEntry>
|
||||||
@ -58,7 +57,6 @@ export class PeopleApi extends BaseApi {
|
|||||||
* Deletes the avatar image related to person **personId**.
|
* Deletes the avatar image related to person **personId**.
|
||||||
* You must be the person or have admin rights to update a person's avatar.
|
* You must be the person or have admin rights to update a person's avatar.
|
||||||
* You can use the -me- string in place of <personId> to specify the currently authenticated user.
|
* You can use the -me- string in place of <personId> to specify the currently authenticated user.
|
||||||
*
|
|
||||||
* @param personId The identifier of a person.
|
* @param personId The identifier of a person.
|
||||||
* @returns Promise<{}>
|
* @returns Promise<{}>
|
||||||
*/
|
*/
|
||||||
@ -84,7 +82,6 @@ export class PeopleApi extends BaseApi {
|
|||||||
* the **placeholder** query parameter can be optionally used to request a placeholder image to be returned.
|
* the **placeholder** query parameter can be optionally used to request a placeholder image to be returned.
|
||||||
*
|
*
|
||||||
* You can use the -me- string in place of <personId> to specify the currently authenticated user.
|
* You can use the -me- string in place of <personId> to specify the currently authenticated user.
|
||||||
*
|
|
||||||
* @param personId The identifier of a person.
|
* @param personId The identifier of a person.
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
* @param opts.attachment **true** enables a web browser to download the file as an attachment.
|
* @param opts.attachment **true** enables a web browser to download the file as an attachment.
|
||||||
@ -131,7 +128,6 @@ export class PeopleApi extends BaseApi {
|
|||||||
* Get a person
|
* Get a person
|
||||||
*
|
*
|
||||||
* You can use the `-me-` string in place of <personId> to specify the currently authenticated user.
|
* You can use the `-me-` string in place of <personId> to specify the currently authenticated user.
|
||||||
*
|
|
||||||
* @param personId The identifier of a person.
|
* @param personId The identifier of a person.
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
* @returns Promise<PersonEntry>
|
* @returns Promise<PersonEntry>
|
||||||
@ -171,7 +167,6 @@ export class PeopleApi extends BaseApi {
|
|||||||
* - id
|
* - id
|
||||||
* - firstName
|
* - firstName
|
||||||
* - lastName
|
* - lastName
|
||||||
*
|
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
* @param opts.orderBy A string to control the order of the entities returned in a list. You can use the **orderBy** parameter to
|
* @param opts.orderBy A string to control the order of the entities returned in a list. You can use the **orderBy** parameter to
|
||||||
* sort the list by one or more fields.
|
* sort the list by one or more fields.
|
||||||
@ -209,7 +204,6 @@ export class PeopleApi extends BaseApi {
|
|||||||
*
|
*
|
||||||
* **Note:** this endpoint is available in Alfresco 5.2.1 and newer versions.
|
* **Note:** this endpoint is available in Alfresco 5.2.1 and newer versions.
|
||||||
* **Note:** No authentication is required to call this endpoint.
|
* **Note:** No authentication is required to call this endpoint.
|
||||||
*
|
|
||||||
* @param personId The identifier of a person.
|
* @param personId The identifier of a person.
|
||||||
* @param clientBody The client name to send email with app-specific url.
|
* @param clientBody The client name to send email with app-specific url.
|
||||||
* @returns Promise<{}>
|
* @returns Promise<{}>
|
||||||
@ -234,7 +228,6 @@ export class PeopleApi extends BaseApi {
|
|||||||
*
|
*
|
||||||
* **Note:** this endpoint is available in Alfresco 5.2.1 and newer versions.
|
* **Note:** this endpoint is available in Alfresco 5.2.1 and newer versions.
|
||||||
* **Note:** No authentication is required to call this endpoint.
|
* **Note:** No authentication is required to call this endpoint.
|
||||||
*
|
|
||||||
* @param personId The identifier of a person.
|
* @param personId The identifier of a person.
|
||||||
* @param passwordResetBody The reset password details
|
* @param passwordResetBody The reset password details
|
||||||
* @returns Promise<{}>
|
* @returns Promise<{}>
|
||||||
@ -267,7 +260,6 @@ export class PeopleApi extends BaseApi {
|
|||||||
* You must be the person or have admin rights to update a person's avatar.
|
* You must be the person or have admin rights to update a person's avatar.
|
||||||
*
|
*
|
||||||
* You can use the -me- string in place of <personId> to specify the currently authenticated user.
|
* You can use the -me- string in place of <personId> to specify the currently authenticated user.
|
||||||
*
|
|
||||||
* @param personId The identifier of a person.
|
* @param personId The identifier of a person.
|
||||||
* @param contentBodyUpdate The binary content
|
* @param contentBodyUpdate The binary content
|
||||||
* @returns Promise<{}>
|
* @returns Promise<{}>
|
||||||
@ -304,7 +296,6 @@ export class PeopleApi extends BaseApi {
|
|||||||
* Admin users cannot be disabled by setting enabled to false.
|
* Admin users cannot be disabled by setting enabled to false.
|
||||||
* Non-admin users may not disable themselves.
|
* Non-admin users may not disable themselves.
|
||||||
* **Note:** setting properties of type d:content and d:category are not supported.
|
* **Note:** setting properties of type d:content and d:category are not supported.
|
||||||
*
|
|
||||||
* @param personId The identifier of a person.
|
* @param personId The identifier of a person.
|
||||||
* @param personBodyUpdate The person details.
|
* @param personBodyUpdate The person details.
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
|
@ -30,7 +30,6 @@ export class PreferencesApi extends BaseApi {
|
|||||||
*
|
*
|
||||||
* Gets a specific preference for person **personId**.
|
* Gets a specific preference for person **personId**.
|
||||||
* You can use the -me- string in place of <personId> to specify the currently authenticated user.
|
* You can use the -me- string in place of <personId> to specify the currently authenticated user.
|
||||||
*
|
|
||||||
* @param personId The identifier of a person.
|
* @param personId The identifier of a person.
|
||||||
* @param preferenceName The name of the preference.
|
* @param preferenceName The name of the preference.
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
@ -63,7 +62,6 @@ export class PreferencesApi extends BaseApi {
|
|||||||
* Note that each preference consists of an **id** and a **value**.
|
* Note that each preference consists of an **id** and a **value**.
|
||||||
*
|
*
|
||||||
* The **value** can be of any JSON type.
|
* The **value** can be of any JSON type.
|
||||||
*
|
|
||||||
* @param personId The identifier of a person.
|
* @param personId The identifier of a person.
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
* @returns Promise<PreferencePaging>
|
* @returns Promise<PreferencePaging>
|
||||||
|
@ -32,7 +32,6 @@ export class ProbesApi extends BaseApi {
|
|||||||
* The readiness probe is normally only used to check repository startup.
|
* The readiness probe is normally only used to check repository startup.
|
||||||
* The liveness probe should then be used to check the repository is still responding to requests.
|
* The liveness probe should then be used to check the repository is still responding to requests.
|
||||||
* **Note:** No authentication is required to call this endpoint.
|
* **Note:** No authentication is required to call this endpoint.
|
||||||
*
|
|
||||||
* @param probeId The name of the probe:
|
* @param probeId The name of the probe:
|
||||||
* - -ready-
|
* - -ready-
|
||||||
* - -live-
|
* - -live-
|
||||||
|
@ -79,7 +79,6 @@ export class QueriesApi extends BaseApi {
|
|||||||
* - name
|
* - name
|
||||||
* - modifiedAt
|
* - modifiedAt
|
||||||
* - createdAt
|
* - createdAt
|
||||||
*
|
|
||||||
* @param term The term to search for.
|
* @param term The term to search for.
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
* @returns Promise<NodePaging>
|
* @returns Promise<NodePaging>
|
||||||
@ -122,7 +121,6 @@ export class QueriesApi extends BaseApi {
|
|||||||
* - id
|
* - id
|
||||||
* - firstName
|
* - firstName
|
||||||
* - lastName
|
* - lastName
|
||||||
*
|
|
||||||
* @param term The term to search for.
|
* @param term The term to search for.
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
* @returns Promise<PersonPaging>
|
* @returns Promise<PersonPaging>
|
||||||
@ -164,7 +162,6 @@ export class QueriesApi extends BaseApi {
|
|||||||
* - id
|
* - id
|
||||||
* - title
|
* - title
|
||||||
* - description
|
* - description
|
||||||
*
|
|
||||||
* @param term The term to search for.
|
* @param term The term to search for.
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
* @returns Promise<SitePaging>
|
* @returns Promise<SitePaging>
|
||||||
|
@ -29,7 +29,6 @@ import { ContentFieldsQuery, ContentPagingQuery } from './types';
|
|||||||
export class RatingsApi extends BaseApi {
|
export class RatingsApi extends BaseApi {
|
||||||
/**
|
/**
|
||||||
* Create a rating
|
* Create a rating
|
||||||
*
|
|
||||||
* @param nodeId The identifier of a node.
|
* @param nodeId The identifier of a node.
|
||||||
* @param ratingBodyCreate For \"myRating\" the type is specific to the rating scheme, boolean for the likes and an integer for the fiveStar.
|
* @param ratingBodyCreate For \"myRating\" the type is specific to the rating scheme, boolean for the likes and an integer for the fiveStar.
|
||||||
* For example, to \"like\" a file the following body would be used:
|
* For example, to \"like\" a file the following body would be used:
|
||||||
@ -67,7 +66,6 @@ export class RatingsApi extends BaseApi {
|
|||||||
* Delete a rating
|
* Delete a rating
|
||||||
*
|
*
|
||||||
* Deletes rating **ratingId** from node **nodeId**.
|
* Deletes rating **ratingId** from node **nodeId**.
|
||||||
*
|
|
||||||
* @param nodeId The identifier of a node.
|
* @param nodeId The identifier of a node.
|
||||||
* @param ratingId The identifier of a rating.
|
* @param ratingId The identifier of a rating.
|
||||||
* @returns Promise<{}>
|
* @returns Promise<{}>
|
||||||
@ -91,7 +89,6 @@ export class RatingsApi extends BaseApi {
|
|||||||
* Get a rating
|
* Get a rating
|
||||||
*
|
*
|
||||||
* Get the specific rating **ratingId** on node **nodeId**.
|
* Get the specific rating **ratingId** on node **nodeId**.
|
||||||
*
|
|
||||||
* @param nodeId The identifier of a node.
|
* @param nodeId The identifier of a node.
|
||||||
* @param ratingId The identifier of a rating.
|
* @param ratingId The identifier of a rating.
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
@ -122,7 +119,6 @@ export class RatingsApi extends BaseApi {
|
|||||||
* List ratings
|
* List ratings
|
||||||
*
|
*
|
||||||
* Gets a list of ratings for node **nodeId**.
|
* Gets a list of ratings for node **nodeId**.
|
||||||
*
|
|
||||||
* @param nodeId The identifier of a node.
|
* @param nodeId The identifier of a node.
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
* @returns Promise<RatingPaging>
|
* @returns Promise<RatingPaging>
|
||||||
|
@ -27,7 +27,6 @@ export class RenditionsApi extends BaseApi {
|
|||||||
* Create rendition
|
* Create rendition
|
||||||
*
|
*
|
||||||
* **Note:** this endpoint is available in Alfresco 5.2 and newer versions.
|
* **Note:** this endpoint is available in Alfresco 5.2 and newer versions.
|
||||||
*
|
|
||||||
* @param nodeId The identifier of a node.
|
* @param nodeId The identifier of a node.
|
||||||
* @param renditionBodyCreate The rendition \"id\".
|
* @param renditionBodyCreate The rendition \"id\".
|
||||||
* @returns Promise<{}>
|
* @returns Promise<{}>
|
||||||
@ -51,7 +50,6 @@ export class RenditionsApi extends BaseApi {
|
|||||||
* Get rendition information
|
* Get rendition information
|
||||||
*
|
*
|
||||||
* **Note:** this endpoint is available in Alfresco 5.2 and newer versions.
|
* **Note:** this endpoint is available in Alfresco 5.2 and newer versions.
|
||||||
*
|
|
||||||
* @param nodeId The identifier of a node.
|
* @param nodeId The identifier of a node.
|
||||||
* @param renditionId The name of a thumbnail rendition, for example *doclib*, or *pdf*.
|
* @param renditionId The name of a thumbnail rendition, for example *doclib*, or *pdf*.
|
||||||
* @returns Promise<RenditionEntry>
|
* @returns Promise<RenditionEntry>
|
||||||
@ -76,7 +74,6 @@ export class RenditionsApi extends BaseApi {
|
|||||||
* Get rendition content
|
* Get rendition content
|
||||||
*
|
*
|
||||||
* **Note:** this endpoint is available in Alfresco 5.2 and newer versions.
|
* **Note:** this endpoint is available in Alfresco 5.2 and newer versions.
|
||||||
*
|
|
||||||
* @param nodeId The identifier of a node.
|
* @param nodeId The identifier of a node.
|
||||||
* @param renditionId The name of a thumbnail rendition, for example *doclib*, or *pdf*.
|
* @param renditionId The name of a thumbnail rendition, for example *doclib*, or *pdf*.
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
@ -143,7 +140,6 @@ export class RenditionsApi extends BaseApi {
|
|||||||
* You can use the **where** parameter to filter the returned renditions by **status**. For example, the following **where**
|
* You can use the **where** parameter to filter the returned renditions by **status**. For example, the following **where**
|
||||||
* clause will return just the CREATED renditions:
|
* clause will return just the CREATED renditions:
|
||||||
* - (status='CREATED')
|
* - (status='CREATED')
|
||||||
*
|
|
||||||
* @param nodeId The identifier of a node.
|
* @param nodeId The identifier of a node.
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
* @param opts.where A string to restrict the returned objects by using a predicate.
|
* @param opts.where A string to restrict the returned objects by using a predicate.
|
||||||
@ -168,7 +164,6 @@ export class RenditionsApi extends BaseApi {
|
|||||||
* Generate a direct access content url for a given rendition of a node
|
* Generate a direct access content url for a given rendition of a node
|
||||||
*
|
*
|
||||||
* **Note:** this endpoint is available in Alfresco 7.1 and newer versions.
|
* **Note:** this endpoint is available in Alfresco 7.1 and newer versions.
|
||||||
*
|
|
||||||
* @param nodeId The identifier of a node.
|
* @param nodeId The identifier of a node.
|
||||||
* @param renditionId The identifier of a version
|
* @param renditionId The identifier of a version
|
||||||
* @returns Promise<DirectAccessUrlEntry>
|
* @returns Promise<DirectAccessUrlEntry>
|
||||||
|
@ -24,7 +24,6 @@ import { BaseApi } from '../../hxi-connector-api/api/base.api';
|
|||||||
export class SearchAiApi extends BaseApi {
|
export class SearchAiApi extends BaseApi {
|
||||||
/**
|
/**
|
||||||
* Ask a question to the AI.
|
* Ask a question to the AI.
|
||||||
*
|
|
||||||
* @param questions QuestionRequest array containing questions to ask.
|
* @param questions QuestionRequest array containing questions to ask.
|
||||||
* @returns QuestionModel object containing information about questions.
|
* @returns QuestionModel object containing information about questions.
|
||||||
*/
|
*/
|
||||||
@ -41,7 +40,6 @@ export class SearchAiApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get an answer to specific question.
|
* Get an answer to specific question.
|
||||||
*
|
|
||||||
* @param questionId The ID of the question to get an answer for.
|
* @param questionId The ID of the question to get an answer for.
|
||||||
* @returns AiAnswerEntry object containing the answer.
|
* @returns AiAnswerEntry object containing the answer.
|
||||||
*/
|
*/
|
||||||
@ -53,7 +51,6 @@ export class SearchAiApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get the knowledge retrieval configuration.
|
* Get the knowledge retrieval configuration.
|
||||||
*
|
|
||||||
* @returns KnowledgeRetrievalConfigEntry object containing the configuration.
|
* @returns KnowledgeRetrievalConfigEntry object containing the configuration.
|
||||||
*/
|
*/
|
||||||
getConfig(): Promise<KnowledgeRetrievalConfigEntry> {
|
getConfig(): Promise<KnowledgeRetrievalConfigEntry> {
|
||||||
|
@ -34,7 +34,6 @@ export class SharedlinksApi extends BaseApi {
|
|||||||
* Create a shared link to a file
|
* Create a shared link to a file
|
||||||
*
|
*
|
||||||
* **Note:** this endpoint is available in Alfresco 5.2 and newer versions.
|
* **Note:** this endpoint is available in Alfresco 5.2 and newer versions.
|
||||||
*
|
|
||||||
* @param sharedLinkBodyCreate The nodeId to create a shared link for.
|
* @param sharedLinkBodyCreate The nodeId to create a shared link for.
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
* @returns Promise<SharedLinkEntry>
|
* @returns Promise<SharedLinkEntry>
|
||||||
@ -59,7 +58,6 @@ export class SharedlinksApi extends BaseApi {
|
|||||||
* Deletes a shared link
|
* Deletes a shared link
|
||||||
*
|
*
|
||||||
* **Note:** this endpoint is available in Alfresco 5.2 and newer versions.
|
* **Note:** this endpoint is available in Alfresco 5.2 and newer versions.
|
||||||
*
|
|
||||||
* @param sharedId The identifier of a shared link to a file.
|
* @param sharedId The identifier of a shared link to a file.
|
||||||
* @returns Promise<{}>
|
* @returns Promise<{}>
|
||||||
*/
|
*/
|
||||||
@ -80,7 +78,6 @@ export class SharedlinksApi extends BaseApi {
|
|||||||
* Email shared link
|
* Email shared link
|
||||||
*
|
*
|
||||||
* **Note:** this endpoint is available in Alfresco 5.2 and newer versions.
|
* **Note:** this endpoint is available in Alfresco 5.2 and newer versions.
|
||||||
*
|
|
||||||
* @param sharedId The identifier of a shared link to a file.
|
* @param sharedId The identifier of a shared link to a file.
|
||||||
* @param sharedLinkBodyEmail The shared link email to send.
|
* @param sharedLinkBodyEmail The shared link email to send.
|
||||||
* @returns Promise<{}>
|
* @returns Promise<{}>
|
||||||
@ -105,7 +102,6 @@ export class SharedlinksApi extends BaseApi {
|
|||||||
*
|
*
|
||||||
* **Note:** this endpoint is available in Alfresco 5.2 and newer versions.
|
* **Note:** this endpoint is available in Alfresco 5.2 and newer versions.
|
||||||
* **Note:** No authentication is required to call this endpoint.
|
* **Note:** No authentication is required to call this endpoint.
|
||||||
*
|
|
||||||
* @param sharedId The identifier of a shared link to a file.
|
* @param sharedId The identifier of a shared link to a file.
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
* @returns Promise<SharedLinkEntry>
|
* @returns Promise<SharedLinkEntry>
|
||||||
@ -134,7 +130,6 @@ export class SharedlinksApi extends BaseApi {
|
|||||||
*
|
*
|
||||||
* **Note:** this endpoint is available in Alfresco 5.2 and newer versions.
|
* **Note:** this endpoint is available in Alfresco 5.2 and newer versions.
|
||||||
* **Note:** No authentication is required to call this endpoint.
|
* **Note:** No authentication is required to call this endpoint.
|
||||||
*
|
|
||||||
* @param sharedId The identifier of a shared link to a file.
|
* @param sharedId The identifier of a shared link to a file.
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
* @param opts.attachment **true** enables a web browser to download the file as an attachment.
|
* @param opts.attachment **true** enables a web browser to download the file as an attachment.
|
||||||
@ -190,7 +185,6 @@ export class SharedlinksApi extends BaseApi {
|
|||||||
* which means the rendition is available to view/download.
|
* which means the rendition is available to view/download.
|
||||||
*
|
*
|
||||||
* **Note:** No authentication is required to call this endpoint.
|
* **Note:** No authentication is required to call this endpoint.
|
||||||
*
|
|
||||||
* @param sharedId The identifier of a shared link to a file.
|
* @param sharedId The identifier of a shared link to a file.
|
||||||
* @param renditionId The name of a thumbnail rendition, for example *doclib*, or *pdf*.
|
* @param renditionId The name of a thumbnail rendition, for example *doclib*, or *pdf*.
|
||||||
* @returns Promise<RenditionEntry>
|
* @returns Promise<RenditionEntry>
|
||||||
@ -216,7 +210,6 @@ export class SharedlinksApi extends BaseApi {
|
|||||||
*
|
*
|
||||||
* **Note:** this endpoint is available in Alfresco 5.2 and newer versions.
|
* **Note:** this endpoint is available in Alfresco 5.2 and newer versions.
|
||||||
* **Note:** No authentication is required to call this endpoint.
|
* **Note:** No authentication is required to call this endpoint.
|
||||||
*
|
|
||||||
* @param sharedId The identifier of a shared link to a file.
|
* @param sharedId The identifier of a shared link to a file.
|
||||||
* @param renditionId The name of a thumbnail rendition, for example *doclib*, or *pdf*.
|
* @param renditionId The name of a thumbnail rendition, for example *doclib*, or *pdf*.
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
@ -278,7 +271,6 @@ export class SharedlinksApi extends BaseApi {
|
|||||||
* where the rendition status is CREATED, which means the rendition is available to view/download.
|
* where the rendition status is CREATED, which means the rendition is available to view/download.
|
||||||
*
|
*
|
||||||
* **Note:** No authentication is required to call this endpoint.
|
* **Note:** No authentication is required to call this endpoint.
|
||||||
*
|
|
||||||
* @param sharedId The identifier of a shared link to a file.
|
* @param sharedId The identifier of a shared link to a file.
|
||||||
* @returns Promise<RenditionPaging>
|
* @returns Promise<RenditionPaging>
|
||||||
*/
|
*/
|
||||||
@ -305,7 +297,6 @@ export class SharedlinksApi extends BaseApi {
|
|||||||
* The list is ordered in descending modified order.
|
* The list is ordered in descending modified order.
|
||||||
*
|
*
|
||||||
* **Note:** The list of links is eventually consistent so newly created shared links may not appear immediately.
|
* **Note:** The list of links is eventually consistent so newly created shared links may not appear immediately.
|
||||||
*
|
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
* @param opts.where Optionally filter the list by \"sharedByUser\" `userId` of person who shared the link (can also use -me-)
|
* @param opts.where Optionally filter the list by \"sharedByUser\" `userId` of person who shared the link (can also use -me-)
|
||||||
* where=(sharedByUser='jbloggs')
|
* where=(sharedByUser='jbloggs')
|
||||||
|
@ -47,7 +47,6 @@ import { ContentFieldsQuery, ContentPagingQuery } from './types';
|
|||||||
export class SitesApi extends BaseApi {
|
export class SitesApi extends BaseApi {
|
||||||
/**
|
/**
|
||||||
* Approve a site membership request
|
* Approve a site membership request
|
||||||
*
|
|
||||||
* @param siteId The identifier of a site.
|
* @param siteId The identifier of a site.
|
||||||
* @param inviteeId The invitee username.
|
* @param inviteeId The invitee username.
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
@ -76,7 +75,6 @@ export class SitesApi extends BaseApi {
|
|||||||
* Create a site
|
* Create a site
|
||||||
*
|
*
|
||||||
* **Note:** this endpoint is available in Alfresco 5.2 and newer versions.
|
* **Note:** this endpoint is available in Alfresco 5.2 and newer versions.
|
||||||
*
|
|
||||||
* @param siteBodyCreate The site details
|
* @param siteBodyCreate The site details
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
* @param opts.skipConfiguration Flag to indicate whether the Share-specific (surf) configuration files for the site should not be created. (default to false)
|
* @param opts.skipConfiguration Flag to indicate whether the Share-specific (surf) configuration files for the site should not be created. (default to false)
|
||||||
@ -111,7 +109,6 @@ export class SitesApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Create a site membership
|
* Create a site membership
|
||||||
*
|
|
||||||
* @param siteId The identifier of a site.
|
* @param siteId The identifier of a site.
|
||||||
* @param siteMembershipBodyCreate The person to add and their role
|
* @param siteMembershipBodyCreate The person to add and their role
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
@ -144,7 +141,6 @@ export class SitesApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Create a site membership request
|
* Create a site membership request
|
||||||
*
|
|
||||||
* @param personId The identifier of a person.
|
* @param personId The identifier of a person.
|
||||||
* @param siteMembershipRequestBodyCreate Site membership request details
|
* @param siteMembershipRequestBodyCreate Site membership request details
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
@ -178,7 +174,6 @@ export class SitesApi extends BaseApi {
|
|||||||
/**
|
/**
|
||||||
* Delete a site
|
* Delete a site
|
||||||
* **Note:** this endpoint is available in Alfresco 5.2 and newer versions.
|
* **Note:** this endpoint is available in Alfresco 5.2 and newer versions.
|
||||||
*
|
|
||||||
* @param siteId The identifier of a site.
|
* @param siteId The identifier of a site.
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
* @param opts.permanent Flag to indicate whether the site should be permanently deleted i.e. bypass the trashcan. (default to false)
|
* @param opts.permanent Flag to indicate whether the site should be permanently deleted i.e. bypass the trashcan. (default to false)
|
||||||
@ -205,7 +200,6 @@ export class SitesApi extends BaseApi {
|
|||||||
/**
|
/**
|
||||||
* Delete a site membership
|
* Delete a site membership
|
||||||
* You can use the -me- string in place of <personId> to specify the currently authenticated user.
|
* You can use the -me- string in place of <personId> to specify the currently authenticated user.
|
||||||
*
|
|
||||||
* @param siteId The identifier of a site.
|
* @param siteId The identifier of a site.
|
||||||
* @param personId The identifier of a person.
|
* @param personId The identifier of a person.
|
||||||
* @returns Promise<{}>
|
* @returns Promise<{}>
|
||||||
@ -230,7 +224,6 @@ export class SitesApi extends BaseApi {
|
|||||||
*
|
*
|
||||||
* Deletes person **personId** as a member of site **siteId**.
|
* Deletes person **personId** as a member of site **siteId**.
|
||||||
* You can use the -me- string in place of <personId> to specify the currently authenticated user.
|
* You can use the -me- string in place of <personId> to specify the currently authenticated user.
|
||||||
*
|
|
||||||
* @param personId The identifier of a person.
|
* @param personId The identifier of a person.
|
||||||
* @param siteId The identifier of a site.
|
* @param siteId The identifier of a site.
|
||||||
* @returns Promise<{}>
|
* @returns Promise<{}>
|
||||||
@ -255,7 +248,6 @@ export class SitesApi extends BaseApi {
|
|||||||
*
|
*
|
||||||
* Deletes the site membership request to site **siteId** for person **personId**.
|
* Deletes the site membership request to site **siteId** for person **personId**.
|
||||||
* You can use the -me- string in place of <personId> to specify the currently authenticated user.
|
* You can use the -me- string in place of <personId> to specify the currently authenticated user.
|
||||||
*
|
|
||||||
* @param personId The identifier of a person.
|
* @param personId The identifier of a person.
|
||||||
* @param siteId The identifier of a site.
|
* @param siteId The identifier of a site.
|
||||||
* @returns Promise<{}>
|
* @returns Promise<{}>
|
||||||
@ -289,7 +281,6 @@ export class SitesApi extends BaseApi {
|
|||||||
* objects related to the site **siteId**:
|
* objects related to the site **siteId**:
|
||||||
*
|
*
|
||||||
* containers,members
|
* containers,members
|
||||||
*
|
|
||||||
* @param siteId The identifier of a site.
|
* @param siteId The identifier of a site.
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
* @param opts.relations Use the relations parameter to include one or more related entities in a single response.
|
* @param opts.relations Use the relations parameter to include one or more related entities in a single response.
|
||||||
@ -319,7 +310,6 @@ export class SitesApi extends BaseApi {
|
|||||||
* Get a site container
|
* Get a site container
|
||||||
*
|
*
|
||||||
* Gets information on the container **containerId** in site **siteId**.
|
* Gets information on the container **containerId** in site **siteId**.
|
||||||
*
|
|
||||||
* @param siteId The identifier of a site.
|
* @param siteId The identifier of a site.
|
||||||
* @param containerId The unique identifier of a site container.
|
* @param containerId The unique identifier of a site container.
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
@ -350,7 +340,6 @@ export class SitesApi extends BaseApi {
|
|||||||
*
|
*
|
||||||
* Gets site membership information for person **personId** on site **siteId**.
|
* Gets site membership information for person **personId** on site **siteId**.
|
||||||
* You can use the -me- string in place of <personId> to specify the currently authenticated user.
|
* You can use the -me- string in place of <personId> to specify the currently authenticated user.
|
||||||
*
|
|
||||||
* @param siteId The identifier of a site.
|
* @param siteId The identifier of a site.
|
||||||
* @param personId The identifier of a person.
|
* @param personId The identifier of a person.
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
@ -382,7 +371,6 @@ export class SitesApi extends BaseApi {
|
|||||||
*
|
*
|
||||||
* Gets site membership information for person **personId** on site **siteId**.
|
* Gets site membership information for person **personId** on site **siteId**.
|
||||||
* You can use the -me- string in place of <personId> to specify the currently authenticated user.
|
* You can use the -me- string in place of <personId> to specify the currently authenticated user.
|
||||||
*
|
|
||||||
* @param personId The identifier of a person.
|
* @param personId The identifier of a person.
|
||||||
* @param siteId The identifier of a site.
|
* @param siteId The identifier of a site.
|
||||||
* @returns Promise<SiteRoleEntry>
|
* @returns Promise<SiteRoleEntry>
|
||||||
@ -408,7 +396,6 @@ export class SitesApi extends BaseApi {
|
|||||||
*
|
*
|
||||||
* Gets the site membership request for site **siteId** for person **personId**, if one exists.
|
* Gets the site membership request for site **siteId** for person **personId**, if one exists.
|
||||||
* You can use the -me- string in place of <personId> to specify the currently authenticated user.
|
* You can use the -me- string in place of <personId> to specify the currently authenticated user.
|
||||||
*
|
|
||||||
* @param personId The identifier of a person.
|
* @param personId The identifier of a person.
|
||||||
* @param siteId The identifier of a site.
|
* @param siteId The identifier of a site.
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
@ -449,7 +436,6 @@ export class SitesApi extends BaseApi {
|
|||||||
* This may be combined with the siteId filter, as shown below:
|
* This may be combined with the siteId filter, as shown below:
|
||||||
*
|
*
|
||||||
* where=(siteId=mySite AND personId=person))
|
* where=(siteId=mySite AND personId=person))
|
||||||
*
|
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
* @param opts.where A string to restrict the returned objects by using a predicate.
|
* @param opts.where A string to restrict the returned objects by using a predicate.
|
||||||
* @returns Promise<SiteMembershipRequestWithPersonPaging>
|
* @returns Promise<SiteMembershipRequestWithPersonPaging>
|
||||||
@ -473,7 +459,6 @@ export class SitesApi extends BaseApi {
|
|||||||
* List site containers
|
* List site containers
|
||||||
*
|
*
|
||||||
* Gets a list of containers for the site **siteId**.
|
* Gets a list of containers for the site **siteId**.
|
||||||
*
|
|
||||||
* @param siteId The identifier of a site.
|
* @param siteId The identifier of a site.
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
* @returns Promise<SiteContainerPaging>
|
* @returns Promise<SiteContainerPaging>
|
||||||
@ -504,7 +489,6 @@ export class SitesApi extends BaseApi {
|
|||||||
*
|
*
|
||||||
* Gets a list of the current site membership requests for person **personId**.
|
* Gets a list of the current site membership requests for person **personId**.
|
||||||
* You can use the -me- string in place of <personId> to specify the currently authenticated user.
|
* You can use the -me- string in place of <personId> to specify the currently authenticated user.
|
||||||
*
|
|
||||||
* @param personId The identifier of a person.
|
* @param personId The identifier of a person.
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
* @returns Promise<SiteMembershipRequestPaging>
|
* @returns Promise<SiteMembershipRequestPaging>
|
||||||
@ -534,7 +518,6 @@ export class SitesApi extends BaseApi {
|
|||||||
* List site memberships
|
* List site memberships
|
||||||
*
|
*
|
||||||
* Gets a list of site memberships for site **siteId**.
|
* Gets a list of site memberships for site **siteId**.
|
||||||
*
|
|
||||||
* @param siteId The identifier of a site.
|
* @param siteId The identifier of a site.
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
* @returns Promise<SiteMemberPaging>
|
* @returns Promise<SiteMemberPaging>
|
||||||
@ -585,7 +568,6 @@ export class SitesApi extends BaseApi {
|
|||||||
* - id
|
* - id
|
||||||
* - title
|
* - title
|
||||||
* - role
|
* - role
|
||||||
*
|
|
||||||
* @param personId The identifier of a person.
|
* @param personId The identifier of a person.
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
* @param opts.orderBy A string to control the order of the entities returned in a list. You can use the **orderBy** parameter to
|
* @param opts.orderBy A string to control the order of the entities returned in a list. You can use the **orderBy** parameter to
|
||||||
@ -657,8 +639,6 @@ export class SitesApi extends BaseApi {
|
|||||||
* objects related to each site:
|
* objects related to each site:
|
||||||
*
|
*
|
||||||
* containers,members
|
* containers,members
|
||||||
*
|
|
||||||
*
|
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
* @param opts.orderBy A string to control the order of the entities returned in a list. You can use the **orderBy** parameter to
|
* @param opts.orderBy A string to control the order of the entities returned in a list. You can use the **orderBy** parameter to
|
||||||
* sort the list by one or more fields.
|
* sort the list by one or more fields.
|
||||||
@ -695,7 +675,6 @@ export class SitesApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Reject a site membership request
|
* Reject a site membership request
|
||||||
*
|
|
||||||
* @param siteId The identifier of a site.
|
* @param siteId The identifier of a site.
|
||||||
* @param inviteeId The invitee username.
|
* @param inviteeId The invitee username.
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
@ -729,7 +708,6 @@ export class SitesApi extends BaseApi {
|
|||||||
* (site) admin can update title, description or visibility.
|
* (site) admin can update title, description or visibility.
|
||||||
*
|
*
|
||||||
* Note: the id of a site cannot be updated once the site has been created.
|
* Note: the id of a site cannot be updated once the site has been created.
|
||||||
*
|
|
||||||
* @param siteId The identifier of a site.
|
* @param siteId The identifier of a site.
|
||||||
* @param siteBodyUpdate The site information to update.
|
* @param siteBodyUpdate The site information to update.
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
@ -768,7 +746,6 @@ export class SitesApi extends BaseApi {
|
|||||||
* - SiteCollaborator
|
* - SiteCollaborator
|
||||||
* - SiteContributor
|
* - SiteContributor
|
||||||
* - SiteManager
|
* - SiteManager
|
||||||
*
|
|
||||||
* @param siteId The identifier of a site.
|
* @param siteId The identifier of a site.
|
||||||
* @param personId The identifier of a person.
|
* @param personId The identifier of a person.
|
||||||
* @param siteMembershipBodyUpdate The persons new role
|
* @param siteMembershipBodyUpdate The persons new role
|
||||||
@ -808,7 +785,6 @@ export class SitesApi extends BaseApi {
|
|||||||
*
|
*
|
||||||
* Updates the message for the site membership request to site **siteId** for person **personId**.
|
* Updates the message for the site membership request to site **siteId** for person **personId**.
|
||||||
* You can use the -me- string in place of <personId> to specify the currently authenticated user.
|
* You can use the -me- string in place of <personId> to specify the currently authenticated user.
|
||||||
*
|
|
||||||
* @param personId The identifier of a person.
|
* @param personId The identifier of a person.
|
||||||
* @param siteId The identifier of a site.
|
* @param siteId The identifier of a site.
|
||||||
* @param siteMembershipRequestBodyUpdate The new message to display
|
* @param siteMembershipRequestBodyUpdate The new message to display
|
||||||
@ -852,7 +828,6 @@ export class SitesApi extends BaseApi {
|
|||||||
* - SiteCollaborator
|
* - SiteCollaborator
|
||||||
* - SiteContributor
|
* - SiteContributor
|
||||||
* - SiteManager
|
* - SiteManager
|
||||||
*
|
|
||||||
* @param siteId The identifier of a site.
|
* @param siteId The identifier of a site.
|
||||||
* @param siteMembershipBodyCreate The group to add and it role
|
* @param siteMembershipBodyCreate The group to add and it role
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
@ -887,7 +862,6 @@ export class SitesApi extends BaseApi {
|
|||||||
* List group membership for site
|
* List group membership for site
|
||||||
*
|
*
|
||||||
* **Note:** this endpoint is available in Alfresco 7.0.0 and newer versions.
|
* **Note:** this endpoint is available in Alfresco 7.0.0 and newer versions.
|
||||||
*
|
|
||||||
* @param siteId The identifier of a site.
|
* @param siteId The identifier of a site.
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
* @returns Promise<SiteGroupPaging>
|
* @returns Promise<SiteGroupPaging>
|
||||||
@ -917,7 +891,6 @@ export class SitesApi extends BaseApi {
|
|||||||
* Get information about site membership of group
|
* Get information about site membership of group
|
||||||
* **Note:** this endpoint is available in Alfresco 7.0.0 and newer versions.
|
* **Note:** this endpoint is available in Alfresco 7.0.0 and newer versions.
|
||||||
* Gets site membership information for group **groupId** on site **siteId**.
|
* Gets site membership information for group **groupId** on site **siteId**.
|
||||||
*
|
|
||||||
* @param siteId The identifier of a site.
|
* @param siteId The identifier of a site.
|
||||||
* @param groupId The authorityId of a group.
|
* @param groupId The authorityId of a group.
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
@ -954,7 +927,6 @@ export class SitesApi extends BaseApi {
|
|||||||
* - SiteCollaborator
|
* - SiteCollaborator
|
||||||
* - SiteContributor
|
* - SiteContributor
|
||||||
* - SiteManager
|
* - SiteManager
|
||||||
*
|
|
||||||
* @param siteId The identifier of a site.
|
* @param siteId The identifier of a site.
|
||||||
* @param groupId The authorityId of a group.
|
* @param groupId The authorityId of a group.
|
||||||
* @param siteMembershipBodyUpdate The group new role
|
* @param siteMembershipBodyUpdate The group new role
|
||||||
@ -991,7 +963,6 @@ export class SitesApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Delete a group membership for site
|
* Delete a group membership for site
|
||||||
*
|
|
||||||
* @param siteId The identifier of a site.
|
* @param siteId The identifier of a site.
|
||||||
* @param groupId The authorityId of a group.
|
* @param groupId The authorityId of a group.
|
||||||
* @returns Promise<{}>
|
* @returns Promise<{}>
|
||||||
|
@ -29,7 +29,6 @@ import { ContentFieldsQuery, ContentIncludeQuery, ContentPagingQuery } from './t
|
|||||||
export class TagsApi extends BaseApi {
|
export class TagsApi extends BaseApi {
|
||||||
/**
|
/**
|
||||||
* Create a tag for a node
|
* Create a tag for a node
|
||||||
*
|
|
||||||
* @param nodeId The identifier of a node.
|
* @param nodeId The identifier of a node.
|
||||||
* @param tagBodyCreate The new tag
|
* @param tagBodyCreate The new tag
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
@ -58,7 +57,6 @@ export class TagsApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Delete a tag from a node
|
* Delete a tag from a node
|
||||||
*
|
|
||||||
* @param nodeId The identifier of a node.
|
* @param nodeId The identifier of a node.
|
||||||
* @param tagId The identifier of a tag.
|
* @param tagId The identifier of a tag.
|
||||||
* @returns Promise<{}>
|
* @returns Promise<{}>
|
||||||
@ -80,7 +78,6 @@ export class TagsApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get a tag
|
* Get a tag
|
||||||
*
|
|
||||||
* @param tagId The identifier of a tag.
|
* @param tagId The identifier of a tag.
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
* @returns Promise<TagEntry>
|
* @returns Promise<TagEntry>
|
||||||
@ -106,7 +103,6 @@ export class TagsApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* List tags
|
* List tags
|
||||||
*
|
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
* @param opts.tag Name or pattern for which tag is returned. Example of pattern: *test* which returns tags like 'my test 1'
|
* @param opts.tag Name or pattern for which tag is returned. Example of pattern: *test* which returns tags like 'my test 1'
|
||||||
* @param opts.matching Switches filtering to pattern mode instead of exact mode.
|
* @param opts.matching Switches filtering to pattern mode instead of exact mode.
|
||||||
@ -139,7 +135,6 @@ export class TagsApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* List tags for a node
|
* List tags for a node
|
||||||
*
|
|
||||||
* @param nodeId The identifier of a node.
|
* @param nodeId The identifier of a node.
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
* @returns Promise<TagPaging>
|
* @returns Promise<TagPaging>
|
||||||
@ -167,7 +162,6 @@ export class TagsApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Update a tag
|
* Update a tag
|
||||||
*
|
|
||||||
* @param tagId The identifier of a tag.
|
* @param tagId The identifier of a tag.
|
||||||
* @param tagBodyUpdate The updated tag
|
* @param tagBodyUpdate The updated tag
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
@ -196,7 +190,6 @@ export class TagsApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Deletes a tag by **tagId**. This will cause the tag to be removed from all nodes.
|
* Deletes a tag by **tagId**. This will cause the tag to be removed from all nodes.
|
||||||
*
|
|
||||||
* @param tagId The identifier of a tag.
|
* @param tagId The identifier of a tag.
|
||||||
* @returns Promise<{}>
|
* @returns Promise<{}>
|
||||||
*/
|
*/
|
||||||
@ -215,7 +208,6 @@ export class TagsApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Create specified by **tags** list of tags.
|
* Create specified by **tags** list of tags.
|
||||||
*
|
|
||||||
* @param tags List of tags to create.
|
* @param tags List of tags to create.
|
||||||
* @returns Promise<TagEntry[]>
|
* @returns Promise<TagEntry[]>
|
||||||
*/
|
*/
|
||||||
@ -230,7 +222,6 @@ export class TagsApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Assign tags to node. If tag is new then tag is also created additionally, if tag already exists then it is just assigned.
|
* Assign tags to node. If tag is new then tag is also created additionally, if tag already exists then it is just assigned.
|
||||||
*
|
|
||||||
* @param nodeId Id of node to which tags should be assigned.
|
* @param nodeId Id of node to which tags should be assigned.
|
||||||
* @param tags List of tags to create and assign or just assign if they already exist.
|
* @param tags List of tags to create and assign or just assign if they already exist.
|
||||||
* @returns Promise<TagPaging>
|
* @returns Promise<TagPaging>
|
||||||
@ -246,7 +237,6 @@ export class TagsApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Assign tags to node. If tag is new then tag is also created additionally, if tag already exists then it is just assigned.
|
* Assign tags to node. If tag is new then tag is also created additionally, if tag already exists then it is just assigned.
|
||||||
*
|
|
||||||
* @param nodeId Id of node to which tags should be assigned.
|
* @param nodeId Id of node to which tags should be assigned.
|
||||||
* @param tag List of tags to create and assign or just assign if they already exist.
|
* @param tag List of tags to create and assign or just assign if they already exist.
|
||||||
* @returns Promise<TagEntry>
|
* @returns Promise<TagEntry>
|
||||||
|
@ -28,7 +28,6 @@ import { ContentFieldsQuery, ContentIncludeQuery, ContentPagingQuery } from './t
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Trashcan service.
|
* Trashcan service.
|
||||||
*
|
|
||||||
* @module TrashcanApi
|
* @module TrashcanApi
|
||||||
*/
|
*/
|
||||||
export class TrashcanApi extends BaseApi {
|
export class TrashcanApi extends BaseApi {
|
||||||
@ -36,7 +35,6 @@ export class TrashcanApi extends BaseApi {
|
|||||||
* Permanently delete a deleted node
|
* Permanently delete a deleted node
|
||||||
*
|
*
|
||||||
* **Note:** this endpoint is available in Alfresco 5.2 and newer versions.
|
* **Note:** this endpoint is available in Alfresco 5.2 and newer versions.
|
||||||
*
|
|
||||||
* @param nodeId The identifier of a node.
|
* @param nodeId The identifier of a node.
|
||||||
* @returns Promise<{}>
|
* @returns Promise<{}>
|
||||||
*/
|
*/
|
||||||
@ -57,7 +55,6 @@ export class TrashcanApi extends BaseApi {
|
|||||||
* Get rendition information for a deleted node
|
* Get rendition information for a deleted node
|
||||||
*
|
*
|
||||||
* **Note:** this endpoint is available in Alfresco 5.2 and newer versions.
|
* **Note:** this endpoint is available in Alfresco 5.2 and newer versions.
|
||||||
*
|
|
||||||
* @param nodeId The identifier of a node.
|
* @param nodeId The identifier of a node.
|
||||||
* @param renditionId The name of a thumbnail rendition, for example *doclib*, or *pdf*.
|
* @param renditionId The name of a thumbnail rendition, for example *doclib*, or *pdf*.
|
||||||
* @returns Promise<RenditionEntry>
|
* @returns Promise<RenditionEntry>
|
||||||
@ -82,7 +79,6 @@ export class TrashcanApi extends BaseApi {
|
|||||||
* Get rendition content of a deleted node
|
* Get rendition content of a deleted node
|
||||||
*
|
*
|
||||||
* **Note:** this endpoint is available in Alfresco 5.2 and newer versions.
|
* **Note:** this endpoint is available in Alfresco 5.2 and newer versions.
|
||||||
*
|
|
||||||
* @param nodeId The identifier of a node.
|
* @param nodeId The identifier of a node.
|
||||||
* @param renditionId The name of a thumbnail rendition, for example *doclib*, or *pdf*.
|
* @param renditionId The name of a thumbnail rendition, for example *doclib*, or *pdf*.
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
@ -142,7 +138,6 @@ export class TrashcanApi extends BaseApi {
|
|||||||
* Get a deleted node
|
* Get a deleted node
|
||||||
*
|
*
|
||||||
* **Note:** this endpoint is available in Alfresco 5.2 and newer versions.
|
* **Note:** this endpoint is available in Alfresco 5.2 and newer versions.
|
||||||
*
|
|
||||||
* @param nodeId The identifier of a node.
|
* @param nodeId The identifier of a node.
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
* @returns Promise<DeletedNodeEntry>
|
* @returns Promise<DeletedNodeEntry>
|
||||||
@ -170,7 +165,6 @@ export class TrashcanApi extends BaseApi {
|
|||||||
* Get deleted node content
|
* Get deleted node content
|
||||||
*
|
*
|
||||||
* **Note:** this endpoint is available in Alfresco 5.2 and newer versions.
|
* **Note:** this endpoint is available in Alfresco 5.2 and newer versions.
|
||||||
*
|
|
||||||
* @param nodeId The identifier of a node.
|
* @param nodeId The identifier of a node.
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
* @param opts.attachment **true** enables a web browser to download the file as an attachment.
|
* @param opts.attachment **true** enables a web browser to download the file as an attachment.
|
||||||
@ -232,7 +226,6 @@ export class TrashcanApi extends BaseApi {
|
|||||||
* clause will return just the CREATED renditions:
|
* clause will return just the CREATED renditions:
|
||||||
*
|
*
|
||||||
* - (status='CREATED')
|
* - (status='CREATED')
|
||||||
*
|
|
||||||
* @param nodeId The identifier of a node.
|
* @param nodeId The identifier of a node.
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
* @param opts.where A string to restrict the returned objects by using a predicate.
|
* @param opts.where A string to restrict the returned objects by using a predicate.
|
||||||
@ -265,7 +258,6 @@ export class TrashcanApi extends BaseApi {
|
|||||||
* Gets a list of deleted nodes for the current user.
|
* Gets a list of deleted nodes for the current user.
|
||||||
* If the current user is an administrator deleted nodes for all users will be returned.
|
* If the current user is an administrator deleted nodes for all users will be returned.
|
||||||
* The list of deleted nodes will be ordered with the most recently deleted node at the top of the list.
|
* The list of deleted nodes will be ordered with the most recently deleted node at the top of the list.
|
||||||
*
|
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
* @returns Promise<DeletedNodesPaging>
|
* @returns Promise<DeletedNodesPaging>
|
||||||
*/
|
*/
|
||||||
@ -298,7 +290,6 @@ export class TrashcanApi extends BaseApi {
|
|||||||
*
|
*
|
||||||
* Also, any previously shared link will not be restored since it is deleted at the time
|
* Also, any previously shared link will not be restored since it is deleted at the time
|
||||||
* of delete of each node.
|
* of delete of each node.
|
||||||
*
|
|
||||||
* @param nodeId The identifier of a node.
|
* @param nodeId The identifier of a node.
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
* @param opts.deletedNodeBodyRestore The targetParentId if the node is restored to a new location.
|
* @param opts.deletedNodeBodyRestore The targetParentId if the node is restored to a new location.
|
||||||
@ -336,7 +327,6 @@ export class TrashcanApi extends BaseApi {
|
|||||||
* Generate a direct access content url for a given deleted node
|
* Generate a direct access content url for a given deleted node
|
||||||
*
|
*
|
||||||
* **Note:** this endpoint is available in Alfresco 7.1 and newer versions.
|
* **Note:** this endpoint is available in Alfresco 7.1 and newer versions.
|
||||||
*
|
|
||||||
* @param nodeId The identifier of a node.
|
* @param nodeId The identifier of a node.
|
||||||
* @returns Promise<DirectAccessUrlEntry>
|
* @returns Promise<DirectAccessUrlEntry>
|
||||||
*/
|
*/
|
||||||
@ -358,7 +348,6 @@ export class TrashcanApi extends BaseApi {
|
|||||||
* Generate a direct access content url for a given rendition of a deleted node
|
* Generate a direct access content url for a given rendition of a deleted node
|
||||||
*
|
*
|
||||||
* **Note:** this endpoint is available in Alfresco 7.1 and newer versions.
|
* **Note:** this endpoint is available in Alfresco 7.1 and newer versions.
|
||||||
*
|
|
||||||
* @param nodeId The identifier of a node.
|
* @param nodeId The identifier of a node.
|
||||||
* @param renditionId The identifier of a version
|
* @param renditionId The identifier of a version
|
||||||
* @returns Promise<DirectAccessUrlEntry>
|
* @returns Promise<DirectAccessUrlEntry>
|
||||||
|
@ -23,7 +23,6 @@ import { ContentFieldsQuery, ContentIncludeQuery, ContentPagingQuery } from './t
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Versions service.
|
* Versions service.
|
||||||
*
|
|
||||||
* @module VersionsApi
|
* @module VersionsApi
|
||||||
*/
|
*/
|
||||||
export class VersionsApi extends BaseApi {
|
export class VersionsApi extends BaseApi {
|
||||||
@ -31,7 +30,6 @@ export class VersionsApi extends BaseApi {
|
|||||||
* Create rendition for a file version
|
* Create rendition for a file version
|
||||||
*
|
*
|
||||||
* **Note:** this endpoint is available in Alfresco 7.0.0 and newer versions.
|
* **Note:** this endpoint is available in Alfresco 7.0.0 and newer versions.
|
||||||
*
|
|
||||||
* @param nodeId The identifier of a node.
|
* @param nodeId The identifier of a node.
|
||||||
* @param versionId The identifier of a version, ie. version label, within the version history of a node.
|
* @param versionId The identifier of a version, ie. version label, within the version history of a node.
|
||||||
* @param renditionBodyCreate The rendition \"id\".
|
* @param renditionBodyCreate The rendition \"id\".
|
||||||
@ -70,7 +68,6 @@ export class VersionsApi extends BaseApi {
|
|||||||
* can remove the \"cm:versionable\" aspect (via update node) which will also disable versioning. In this
|
* can remove the \"cm:versionable\" aspect (via update node) which will also disable versioning. In this
|
||||||
* case, you can re-enable versioning by adding back the \"cm:versionable\" aspect or using the version
|
* case, you can re-enable versioning by adding back the \"cm:versionable\" aspect or using the version
|
||||||
* params (majorVersion and comment) on a subsequent file content update.
|
* params (majorVersion and comment) on a subsequent file content update.
|
||||||
*
|
|
||||||
* @param nodeId The identifier of a node.
|
* @param nodeId The identifier of a node.
|
||||||
* @param versionId The identifier of a version, ie. version label, within the version history of a node.
|
* @param versionId The identifier of a version, ie. version label, within the version history of a node.
|
||||||
* @returns Promise<{}>
|
* @returns Promise<{}>
|
||||||
@ -94,7 +91,6 @@ export class VersionsApi extends BaseApi {
|
|||||||
* Get version information
|
* Get version information
|
||||||
*
|
*
|
||||||
* **Note:** this endpoint is available in Alfresco 5.2 and newer versions.
|
* **Note:** this endpoint is available in Alfresco 5.2 and newer versions.
|
||||||
*
|
|
||||||
* @param nodeId The identifier of a node.
|
* @param nodeId The identifier of a node.
|
||||||
* @param versionId The identifier of a version, ie. version label, within the version history of a node.
|
* @param versionId The identifier of a version, ie. version label, within the version history of a node.
|
||||||
* @returns Promise<VersionEntry>
|
* @returns Promise<VersionEntry>
|
||||||
@ -119,7 +115,6 @@ export class VersionsApi extends BaseApi {
|
|||||||
* Get version content
|
* Get version content
|
||||||
*
|
*
|
||||||
* **Note:** this endpoint is available in Alfresco 5.2 and newer versions.
|
* **Note:** this endpoint is available in Alfresco 5.2 and newer versions.
|
||||||
*
|
|
||||||
* @param nodeId The identifier of a node.
|
* @param nodeId The identifier of a node.
|
||||||
* @param versionId The identifier of a version, ie. version label, within the version history of a node.
|
* @param versionId The identifier of a version, ie. version label, within the version history of a node.
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
@ -177,7 +172,6 @@ export class VersionsApi extends BaseApi {
|
|||||||
* Get rendition information for a file version
|
* Get rendition information for a file version
|
||||||
*
|
*
|
||||||
* **Note:** this endpoint is available in Alfresco 7.0.0 and newer versions.
|
* **Note:** this endpoint is available in Alfresco 7.0.0 and newer versions.
|
||||||
*
|
|
||||||
* @param nodeId The identifier of a node.
|
* @param nodeId The identifier of a node.
|
||||||
* @param versionId The identifier of a version, ie. version label, within the version history of a node.
|
* @param versionId The identifier of a version, ie. version label, within the version history of a node.
|
||||||
* @param renditionId The name of a thumbnail rendition, for example *doclib*, or *pdf*.
|
* @param renditionId The name of a thumbnail rendition, for example *doclib*, or *pdf*.
|
||||||
@ -205,7 +199,6 @@ export class VersionsApi extends BaseApi {
|
|||||||
* Get rendition content for a file version
|
* Get rendition content for a file version
|
||||||
*
|
*
|
||||||
* **Note:** this endpoint is available in Alfresco 7.0.0 and newer versions.
|
* **Note:** this endpoint is available in Alfresco 7.0.0 and newer versions.
|
||||||
*
|
|
||||||
* @param nodeId The identifier of a node.
|
* @param nodeId The identifier of a node.
|
||||||
* @param versionId The identifier of a version, ie. version label, within the version history of a node.
|
* @param versionId The identifier of a version, ie. version label, within the version history of a node.
|
||||||
* @param renditionId The name of a thumbnail rendition, for example *doclib*, or *pdf*.
|
* @param renditionId The name of a thumbnail rendition, for example *doclib*, or *pdf*.
|
||||||
@ -281,7 +274,6 @@ export class VersionsApi extends BaseApi {
|
|||||||
*
|
*
|
||||||
* The list is ordered in descending modified order. So the most recent version is first and
|
* The list is ordered in descending modified order. So the most recent version is first and
|
||||||
* the original version is last in the list.
|
* the original version is last in the list.
|
||||||
*
|
|
||||||
* @param nodeId The identifier of a node.
|
* @param nodeId The identifier of a node.
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
* @returns Promise<VersionPaging>
|
* @returns Promise<VersionPaging>
|
||||||
@ -317,7 +309,6 @@ export class VersionsApi extends BaseApi {
|
|||||||
* Each rendition returned has a **status**: CREATED means it is available to view or download, NOT_CREATED means the rendition can be requested.
|
* Each rendition returned has a **status**: CREATED means it is available to view or download, NOT_CREATED means the rendition can be requested.
|
||||||
* You can use the **where** parameter to filter the returned renditions by **status**. For example, the following **where**
|
* You can use the **where** parameter to filter the returned renditions by **status**. For example, the following **where**
|
||||||
* clause will return just the CREATED renditions: (status='CREATED')
|
* clause will return just the CREATED renditions: (status='CREATED')
|
||||||
*
|
|
||||||
* @param nodeId The identifier of a node.
|
* @param nodeId The identifier of a node.
|
||||||
* @param versionId The identifier of a version, ie. version label, within the version history of a node.
|
* @param versionId The identifier of a version, ie. version label, within the version history of a node.
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
@ -349,7 +340,6 @@ export class VersionsApi extends BaseApi {
|
|||||||
* Attempts to revert the version identified by **versionId** and **nodeId** to the live node.
|
* Attempts to revert the version identified by **versionId** and **nodeId** to the live node.
|
||||||
* If the node is successfully reverted then the content and metadata for that versioned node
|
* If the node is successfully reverted then the content and metadata for that versioned node
|
||||||
* will be promoted to the live node and a new version will appear in the version history.
|
* will be promoted to the live node and a new version will appear in the version history.
|
||||||
*
|
|
||||||
* @param nodeId The identifier of a node.
|
* @param nodeId The identifier of a node.
|
||||||
* @param versionId The identifier of a version, ie. version label, within the version history of a node.
|
* @param versionId The identifier of a version, ie. version label, within the version history of a node.
|
||||||
* @param revertBody Optionally, specify a version comment and whether this should be a major version, or not.
|
* @param revertBody Optionally, specify a version comment and whether this should be a major version, or not.
|
||||||
@ -383,7 +373,6 @@ export class VersionsApi extends BaseApi {
|
|||||||
* Generate a direct access content url for a given version of a node
|
* Generate a direct access content url for a given version of a node
|
||||||
*
|
*
|
||||||
* **Note:** this endpoint is available in Alfresco 7.1 and newer versions.
|
* **Note:** this endpoint is available in Alfresco 7.1 and newer versions.
|
||||||
*
|
|
||||||
* @param nodeId The identifier of a node.
|
* @param nodeId The identifier of a node.
|
||||||
* @param versionId The identifier of a version
|
* @param versionId The identifier of a version
|
||||||
* @returns Promise<DirectAccessUrlEntry>
|
* @returns Promise<DirectAccessUrlEntry>
|
||||||
|
@ -26,7 +26,6 @@ export class DiscoveryApi extends BaseApi {
|
|||||||
* Get repository information
|
* Get repository information
|
||||||
*
|
*
|
||||||
* **Note:** this endpoint is available in Alfresco 5.2 and newer versions.
|
* **Note:** this endpoint is available in Alfresco 5.2 and newer versions.
|
||||||
*
|
|
||||||
* @returns Promise<DiscoveryEntry>
|
* @returns Promise<DiscoveryEntry>
|
||||||
*/
|
*/
|
||||||
getRepositoryInformation(): Promise<DiscoveryEntry> {
|
getRepositoryInformation(): Promise<DiscoveryEntry> {
|
||||||
|
@ -25,7 +25,6 @@ import { GsPagingQuery } from './types';
|
|||||||
export class AuthorityClearanceApi extends BaseApi {
|
export class AuthorityClearanceApi extends BaseApi {
|
||||||
/**
|
/**
|
||||||
* Get the authority clearances for a single user/group
|
* Get the authority clearances for a single user/group
|
||||||
*
|
|
||||||
* @param authorityId The name for the authority for which the clearance is to be fetched. Can be left blank in which case it will fetch it for all users with pagination
|
* @param authorityId The name for the authority for which the clearance is to be fetched. Can be left blank in which case it will fetch it for all users with pagination
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
* @returns Promise<AuthorityClearanceGroupPaging>
|
* @returns Promise<AuthorityClearanceGroupPaging>
|
||||||
@ -44,7 +43,6 @@ export class AuthorityClearanceApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Updates the authority clearance.
|
* Updates the authority clearance.
|
||||||
*
|
|
||||||
* @param authorityId The name for the authority for which the clearance is to be updated
|
* @param authorityId The name for the authority for which the clearance is to be updated
|
||||||
* @param authorityClearance AuthorityClearanceBody
|
* @param authorityClearance AuthorityClearanceBody
|
||||||
* @returns Promise<SecurityMarkEntry | SecurityMarkPaging>
|
* @returns Promise<SecurityMarkEntry | SecurityMarkPaging>
|
||||||
|
@ -40,7 +40,6 @@ export interface CombinedInstructionsOpts {
|
|||||||
export class ClassificationGuidesApi extends BaseApi {
|
export class ClassificationGuidesApi extends BaseApi {
|
||||||
/**
|
/**
|
||||||
* Combines instructions from the given topics and the user defined instruction, if any.
|
* Combines instructions from the given topics and the user defined instruction, if any.
|
||||||
*
|
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
* @param opts.instructions Instructions
|
* @param opts.instructions Instructions
|
||||||
* @returns Promise<InstructionEntry>
|
* @returns Promise<InstructionEntry>
|
||||||
@ -54,7 +53,6 @@ export class ClassificationGuidesApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Create a classification guide
|
* Create a classification guide
|
||||||
*
|
|
||||||
* @param classificationGuide Classification guide
|
* @param classificationGuide Classification guide
|
||||||
* @returns Promise<ClassificationGuideEntry>
|
* @returns Promise<ClassificationGuideEntry>
|
||||||
*/
|
*/
|
||||||
@ -69,7 +67,6 @@ export class ClassificationGuidesApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Create a subtopic
|
* Create a subtopic
|
||||||
*
|
|
||||||
* @param topicId The identifier for the topic
|
* @param topicId The identifier for the topic
|
||||||
* @param topic Subtopic
|
* @param topic Subtopic
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
@ -98,7 +95,6 @@ export class ClassificationGuidesApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Create a topic
|
* Create a topic
|
||||||
*
|
|
||||||
* @param classificationGuideId The identifier for the classification guide
|
* @param classificationGuideId The identifier for the classification guide
|
||||||
* @param topic Topic
|
* @param topic Topic
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
@ -127,7 +123,6 @@ export class ClassificationGuidesApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Delete a classification guide
|
* Delete a classification guide
|
||||||
*
|
|
||||||
* @param classificationGuideId The identifier for the classification guide
|
* @param classificationGuideId The identifier for the classification guide
|
||||||
* @returns Promise<{}>
|
* @returns Promise<{}>
|
||||||
*/
|
*/
|
||||||
@ -146,7 +141,6 @@ export class ClassificationGuidesApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Delete a topic
|
* Delete a topic
|
||||||
*
|
|
||||||
* @param topicId The identifier for the topic
|
* @param topicId The identifier for the topic
|
||||||
* @returns Promise<{}>
|
* @returns Promise<{}>
|
||||||
*/
|
*/
|
||||||
@ -165,7 +159,6 @@ export class ClassificationGuidesApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* List all classification guides
|
* List all classification guides
|
||||||
*
|
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
* @param opts.orderBy A string to control the order of the entities returned in a list. You can use the **orderBy** parameter to sort the list by one or more fields.
|
* @param opts.orderBy A string to control the order of the entities returned in a list. You can use the **orderBy** parameter to sort the list by one or more fields.
|
||||||
* Each field has a default sort order, which is normally ascending order. Read the API method implementation notes
|
* Each field has a default sort order, which is normally ascending order. Read the API method implementation notes
|
||||||
@ -194,7 +187,6 @@ export class ClassificationGuidesApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* List all subtopics
|
* List all subtopics
|
||||||
*
|
|
||||||
* @param topicId The identifier for the topic
|
* @param topicId The identifier for the topic
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
* @param opts.orderBy A string to control the order of the entities returned in a list. You can use the **orderBy** parameter to
|
* @param opts.orderBy A string to control the order of the entities returned in a list. You can use the **orderBy** parameter to
|
||||||
@ -243,7 +235,6 @@ export class ClassificationGuidesApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* List all topics
|
* List all topics
|
||||||
*
|
|
||||||
* @param classificationGuideId The identifier for the classification guide
|
* @param classificationGuideId The identifier for the classification guide
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
* @param opts.orderBy A string to control the order of the entities returned in a list. You can use the **orderBy** parameter to
|
* @param opts.orderBy A string to control the order of the entities returned in a list. You can use the **orderBy** parameter to
|
||||||
@ -292,7 +283,6 @@ export class ClassificationGuidesApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get classification guide information
|
* Get classification guide information
|
||||||
*
|
|
||||||
* @param classificationGuideId The identifier for the classification guide
|
* @param classificationGuideId The identifier for the classification guide
|
||||||
* @returns Promise<ClassificationGuideEntry>
|
* @returns Promise<ClassificationGuideEntry>
|
||||||
*/
|
*/
|
||||||
@ -311,7 +301,6 @@ export class ClassificationGuidesApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get topic information
|
* Get topic information
|
||||||
*
|
|
||||||
* @param topicId The identifier for the topic
|
* @param topicId The identifier for the topic
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
* @returns Promise<TopicEntry>
|
* @returns Promise<TopicEntry>
|
||||||
@ -339,7 +328,6 @@ export class ClassificationGuidesApi extends BaseApi {
|
|||||||
* Update a classification guide
|
* Update a classification guide
|
||||||
*
|
*
|
||||||
* Updates the classification guide with id **classificationGuideId**. For example, you can rename a classification guide.
|
* Updates the classification guide with id **classificationGuideId**. For example, you can rename a classification guide.
|
||||||
*
|
|
||||||
* @param classificationGuideId The identifier for the classification guide
|
* @param classificationGuideId The identifier for the classification guide
|
||||||
* @param classificationGuide Classification guide
|
* @param classificationGuide Classification guide
|
||||||
* @returns Promise<ClassificationGuideEntry>
|
* @returns Promise<ClassificationGuideEntry>
|
||||||
@ -364,7 +352,6 @@ export class ClassificationGuidesApi extends BaseApi {
|
|||||||
*
|
*
|
||||||
* Updates the topic with id **topicId**.
|
* Updates the topic with id **topicId**.
|
||||||
* Use this to rename a topic or to add, edit, or remove the instruction associated with it.
|
* Use this to rename a topic or to add, edit, or remove the instruction associated with it.
|
||||||
*
|
|
||||||
* @param topicId The identifier for the topic
|
* @param topicId The identifier for the topic
|
||||||
* @param topic Topic
|
* @param topic Topic
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
|
@ -29,7 +29,6 @@ export class ClassificationReasonsApi extends BaseApi {
|
|||||||
* Creates a new classification reason.
|
* Creates a new classification reason.
|
||||||
*
|
*
|
||||||
* **Note:** You can create more than one reason by specifying a list of reasons in the JSON body.
|
* **Note:** You can create more than one reason by specifying a list of reasons in the JSON body.
|
||||||
*
|
|
||||||
* @param classificationReason Classification reason
|
* @param classificationReason Classification reason
|
||||||
* @returns Promise<ClassificationReasonEntry>
|
* @returns Promise<ClassificationReasonEntry>
|
||||||
*/
|
*/
|
||||||
@ -47,7 +46,6 @@ export class ClassificationReasonsApi extends BaseApi {
|
|||||||
*
|
*
|
||||||
* You can't delete a classification reason that is being used to classify content.
|
* You can't delete a classification reason that is being used to classify content.
|
||||||
* There must be at least one classification reason.
|
* There must be at least one classification reason.
|
||||||
*
|
|
||||||
* @param classificationReasonId The identifier for the classification reason
|
* @param classificationReasonId The identifier for the classification reason
|
||||||
* @returns Promise<{}>
|
* @returns Promise<{}>
|
||||||
*/
|
*/
|
||||||
@ -66,7 +64,6 @@ export class ClassificationReasonsApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* List all classification reasons
|
* List all classification reasons
|
||||||
*
|
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
* @returns Promise<ClassificationReasonsPaging>
|
* @returns Promise<ClassificationReasonsPaging>
|
||||||
*/
|
*/
|
||||||
@ -85,7 +82,6 @@ export class ClassificationReasonsApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get classification reason information
|
* Get classification reason information
|
||||||
*
|
|
||||||
* @param classificationReasonId The identifier for the classification reason
|
* @param classificationReasonId The identifier for the classification reason
|
||||||
* @returns Promise<ClassificationReasonEntry>
|
* @returns Promise<ClassificationReasonEntry>
|
||||||
*/
|
*/
|
||||||
@ -104,7 +100,6 @@ export class ClassificationReasonsApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Updates the classification reason with id **classificationReasonId**. For example, you can change a classification reason code or description.
|
* Updates the classification reason with id **classificationReasonId**. For example, you can change a classification reason code or description.
|
||||||
*
|
|
||||||
* @param classificationReasonId The identifier for the classification reason
|
* @param classificationReasonId The identifier for the classification reason
|
||||||
* @param classificationReason Classification reason
|
* @param classificationReason Classification reason
|
||||||
* @returns Promise<ClassificationReasonEntry>
|
* @returns Promise<ClassificationReasonEntry>
|
||||||
|
@ -26,7 +26,6 @@ import { GsPagingQuery } from './types';
|
|||||||
export class DeclassificationExemptionsApi extends BaseApi {
|
export class DeclassificationExemptionsApi extends BaseApi {
|
||||||
/**
|
/**
|
||||||
* Create a declassification exemption
|
* Create a declassification exemption
|
||||||
*
|
|
||||||
* @param declassificationExemption Declassification exemption
|
* @param declassificationExemption Declassification exemption
|
||||||
* @returns Promise<DeclassificationExemptionEntry>
|
* @returns Promise<DeclassificationExemptionEntry>
|
||||||
*/
|
*/
|
||||||
@ -42,7 +41,6 @@ export class DeclassificationExemptionsApi extends BaseApi {
|
|||||||
/**
|
/**
|
||||||
* Deletes the declassification exemption with id **declassificationExemptionId**.
|
* Deletes the declassification exemption with id **declassificationExemptionId**.
|
||||||
* You can't delete a classification exemption that is being used to classify content.
|
* You can't delete a classification exemption that is being used to classify content.
|
||||||
*
|
|
||||||
* @param declassificationExemptionId The identifier for the declassification exemption
|
* @param declassificationExemptionId The identifier for the declassification exemption
|
||||||
* @returns Promise<{}>
|
* @returns Promise<{}>
|
||||||
*/
|
*/
|
||||||
@ -61,7 +59,6 @@ export class DeclassificationExemptionsApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* List all declassification exemptions
|
* List all declassification exemptions
|
||||||
*
|
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
* @returns Promise<DeclassificationExemptionsPaging>
|
* @returns Promise<DeclassificationExemptionsPaging>
|
||||||
*/
|
*/
|
||||||
@ -74,7 +71,6 @@ export class DeclassificationExemptionsApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get declassification exemption information
|
* Get declassification exemption information
|
||||||
*
|
|
||||||
* @param declassificationExemptionId The identifier for the declassification exemption
|
* @param declassificationExemptionId The identifier for the declassification exemption
|
||||||
* @returns Promise<DeclassificationExemptionEntry>
|
* @returns Promise<DeclassificationExemptionEntry>
|
||||||
*/
|
*/
|
||||||
@ -93,7 +89,6 @@ export class DeclassificationExemptionsApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Update a declassification exemption
|
* Update a declassification exemption
|
||||||
*
|
|
||||||
* @param declassificationExemptionId The identifier for the declassification exemption
|
* @param declassificationExemptionId The identifier for the declassification exemption
|
||||||
* @param declassificationExemption Declassification exemption
|
* @param declassificationExemption Declassification exemption
|
||||||
* @returns Promise<DeclassificationExemptionEntry>
|
* @returns Promise<DeclassificationExemptionEntry>
|
||||||
|
@ -26,7 +26,6 @@ import { throwIfNotDefined } from '../../../assert';
|
|||||||
export class DefaultClassificationValuesApi extends BaseApi {
|
export class DefaultClassificationValuesApi extends BaseApi {
|
||||||
/**
|
/**
|
||||||
* Calculates the default declassification date for **nodeId** based on the properties of the node and the current declassification time frame.
|
* Calculates the default declassification date for **nodeId** based on the properties of the node and the current declassification time frame.
|
||||||
*
|
|
||||||
* @param nodeId The identifier of a node.
|
* @param nodeId The identifier of a node.
|
||||||
* @returns Promise<DeclassificationDate>
|
* @returns Promise<DeclassificationDate>
|
||||||
*/
|
*/
|
||||||
|
@ -27,7 +27,6 @@ import { GsPagingQuery } from './types';
|
|||||||
export class NodeSecurityMarksApi extends BaseApi {
|
export class NodeSecurityMarksApi extends BaseApi {
|
||||||
/**
|
/**
|
||||||
* Add/Remove security mark on a node
|
* Add/Remove security mark on a node
|
||||||
*
|
|
||||||
* @param nodeId The key for the node id.
|
* @param nodeId The key for the node id.
|
||||||
* @param dataBody Array of NodeSecurityMarkBody.
|
* @param dataBody Array of NodeSecurityMarkBody.
|
||||||
* @returns Promise<SecurityMarkPaging>
|
* @returns Promise<SecurityMarkPaging>
|
||||||
@ -49,7 +48,6 @@ export class NodeSecurityMarksApi extends BaseApi {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Get security marks on a node
|
* Get security marks on a node
|
||||||
*
|
|
||||||
* @param nodeId The key for the node id.
|
* @param nodeId The key for the node id.
|
||||||
* @param opts Optional parameters
|
* @param opts Optional parameters
|
||||||
* @returns Promise<SecurityMarkPaging>
|
* @returns Promise<SecurityMarkPaging>
|
||||||
|
Some files were not shown because too many files have changed in this diff Show More
Loading…
x
Reference in New Issue
Block a user