inteligr8/alfresco-ng2-components
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-ng2-components.git synced 2025-07-24 17:32:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

[ADF-2905] Updated JSDocs for core (#3271)

Browse Source
This commit is contained in:
Andy Stark
2018-05-04 19:03:13 +01:00
committed by Eugenio Romano
parent fe0ac0e474
commit c824e646de
18 changed files with 256 additions and 119 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
lib/core/app-config/app-config.service.ts
View File

@@ -44,10 +44,21 @@ export class AppConfigService {
this.onLoad = this.onLoadSubject.asObservable();
}
/**
* Requests notification of a property value when it is loaded.
* @param property The desired property value
* @returns Property value, when loaded
*/
select(property: string): Observable<any> {
return this.onLoadSubject.map((config) => config[property]).distinctUntilChanged();
}
/**
* Gets the value of a named property.
* @param key Name of the property
* @param defaultValue Value to return if the key is not found
* @returns Value of the property
*/
get<T>(key: string, defaultValue?: T): T {
let result: any = ObjectUtils.getValue(this.config, key);
if (typeof result === 'string') {
@@ -63,14 +74,27 @@ export class AppConfigService {
return <T> result;
}
/**
* Gets the location.hostname property.
* @returns Value of the property
*/
getLocationHostname(): string {
return location.hostname;
}
/**
* Gets the location.port property.
* @param prefix Text added before port value
* @returns Port with prefix
*/
getLocationPort(prefix: string = ''): string {
return location.port ? prefix + location.port : '';
}
/**
* Loads the config file.
* @returns Notification when loading is complete
*/
load(): Promise<any> {
return new Promise(resolve => {
this.http.get('app.config.json').subscribe(

3
lib/core/card-view/components/card-view/card-view.component.ts
View File

@@ -24,12 +24,15 @@ import { CardViewItem } from '../../interfaces/card-view-item.interface';
styleUrls: ['./card-view.component.scss']
})
export class CardViewComponent {
/** (**required**) Items to show in the card view. */
@Input()
properties: CardViewItem [];
/** Toggles whether or not the items can be edited. */
@Input()
editable: boolean;
/** Toggles whether or not to show empty items in non-editable mode. */
@Input()
displayEmpty: boolean = true;
}

2
lib/core/context-menu/context-menu.directive.ts
View File

@@ -25,9 +25,11 @@ import { ContextMenuService } from './context-menu.service';
selector: '[adf-context-menu], [context-menu]'
})
export class ContextMenuDirective {
/** Items for the menu. */
@Input('context-menu')
links: any[];
/** Is the menu enabled? */
@Input('context-menu-enabled')
enabled: boolean = false;

55
lib/core/form/services/form.service.ts
View File

@@ -95,6 +95,7 @@ export class FormService {
* @param json JSON to create the form
* @param data Values for the form fields
* @param readOnly Should the form fields be read-only?
* @returns Form model created from input data
*/
parseForm(json: any, data?: FormValues, readOnly: boolean = false): FormModel {
if (json) {
@@ -114,8 +115,9 @@ export class FormService {
}
/**
* Create a Form with a field for each metadata property.
* Creates a Form with a field for each metadata property.
* @param formName Name of the new form
* @returns The new form
*/
createFormFromANode(formName: string): Observable<any> {
return Observable.create(observer => {
@@ -138,6 +140,7 @@ export class FormService {
/**
* Create a Form.
* @param formName Name of the new form
* @returns The new form
*/
createForm(formName: string): Observable<any> {
let dataModel = {
@@ -156,6 +159,7 @@ export class FormService {
* Saves a form.
* @param formId ID of the form to save
* @param formModel Model data for the form
* @returns Data for the saved form
*/
saveForm(formId: string, formModel: FormDefinitionModel): Observable<any> {
return Observable.fromPromise(
@@ -177,8 +181,9 @@ export class FormService {
}
/**
* Search for a form by name.
* Searches for a form by name.
* @param name The form name to search for
* @returns Form model(s) matching the search name
*/
searchFrom(name: string): Observable<any> {
let opts = {
@@ -196,6 +201,7 @@ export class FormService {
/**
* Gets all the forms.
* @returns List of form models
*/
getForms(): Observable<any> {
let opts = {
@@ -208,7 +214,8 @@ export class FormService {
}
/**
* Get Process Definitions
* Gets process definitions.
* @returns List of process definitions
*/
getProcessDefinitions(): Observable<any> {
return Observable.fromPromise(this.processApi.getProcessDefinitions({}))
@@ -217,8 +224,9 @@ export class FormService {
}
/**
* Get instance variables for a process.
* Gets instance variables for a process.
* @param processInstanceId ID of the target process
* @returns List of instance variable information
*/
getProcessVarablesById(processInstanceId: string): Observable<any[]> {
return Observable.fromPromise(this.processInstanceVariablesApi.getProcessInstanceVariables(processInstanceId))
@@ -228,6 +236,7 @@ export class FormService {
/**
* Gets all the tasks.
* @returns List of tasks
*/
getTasks(): Observable<any> {
return Observable.fromPromise(this.taskApi.listTasks({}))
@@ -238,6 +247,7 @@ export class FormService {
/**
* Gets a task.
* @param taskId Task Id
* @returns Task info
*/
getTask(taskId: string): Observable<any> {
return Observable.fromPromise(this.taskApi.getTask(taskId))
@@ -246,9 +256,10 @@ export class FormService {
}
/**
* Save Task Form.
* Saves a task form.
* @param taskId Task Id
* @param formValues Form Values
* @returns Null response when the operation is complete
*/
saveTaskForm(taskId: string, formValues: FormValues): Observable<any> {
let body = JSON.stringify({values: formValues});
@@ -258,10 +269,11 @@ export class FormService {
}
/**
* Complete Task Form
* Completes a Task Form.
* @param taskId Task Id
* @param formValues Form Values
* @param outcome Form Outcome
* @returns Null response when the operation is complete
*/
completeTaskForm(taskId: string, formValues: FormValues, outcome?: string): Observable<any> {
let data: any = {values: formValues};
@@ -275,8 +287,9 @@ export class FormService {
}
/**
* Get Form related to a taskId
* @param taskId Task Id
* Gets a form related to a task.
* @param taskId ID of the target task
* @returns Form definition
*/
getTaskForm(taskId: string): Observable<any> {
return Observable.fromPromise(this.taskApi.getTaskForm(taskId))
@@ -285,8 +298,9 @@ export class FormService {
}
/**
* Get Form Definition
* @param formId Form Id
* Gets a form definition.
* @param formId ID of the target form
* @returns Form definition
*/
getFormDefinitionById(formId: string): Observable<any> {
return Observable.fromPromise(this.editorApi.getForm(formId))
@@ -295,8 +309,9 @@ export class FormService {
}
/**
* Returns form definition with a given name.
* Gets the form definition with a given name.
* @param name The form name
* @returns Form definition
*/
getFormDefinitionByName(name: string): Observable<any> {
let opts = {
@@ -311,8 +326,9 @@ export class FormService {
}
/**
* Get start form instance for a given processId
* Gets the start form instance for a given process.
* @param processId Process definition ID
* @returns Form definition
*/
getStartFormInstance(processId: string): Observable<any> {
return Observable.fromPromise(
@@ -324,6 +340,7 @@ export class FormService {
/**
* Gets a process instance.
* @param processId ID of the process to get
* @returns Process instance
*/
getProcessIntance(processId: string): Observable<any> {
return Observable.fromPromise(this.processApi.getProcessInstance(processId))
@@ -332,8 +349,9 @@ export class FormService {
}
/**
* Get start form definition for a given process
* Gets the start form definition for a given process.
* @param processId Process definition ID
* @returns Form definition
*/
getStartFormDefinition(processId: string): Observable<any> {
return Observable.fromPromise(
@@ -346,6 +364,7 @@ export class FormService {
* Gets values of fields populated by a REST backend.
* @param taskId Task identifier
* @param field Field identifier
* @returns Field values
*/
getRestFieldValues(taskId: string, field: string): Observable<any> {
return Observable.fromPromise(this.taskApi.getRestFieldValues(taskId, field)).catch(err => this.handleError(err));
@@ -355,6 +374,7 @@ export class FormService {
* Gets values of fields populated by a REST backend using a process ID.
* @param processDefinitionId Process identifier
* @param field Field identifier
* @returns Field values
*/
getRestFieldValuesByProcessId(processDefinitionId: string, field: string): Observable<any> {
return Observable.fromPromise(this.processApi.getRestFieldValues(processDefinitionId, field)).catch(err => this.handleError(err));
@@ -365,6 +385,7 @@ export class FormService {
* @param processDefinitionId Process identifier
* @param field Field identifier
* @param column Column identifier
* @returns Field values
*/
getRestFieldValuesColumnByProcessId(processDefinitionId: string, field: string, column?: string): Observable<any> {
return Observable.fromPromise(this.processApi.getRestTableFieldValues(processDefinitionId, field, column)).catch(err => this.handleError(err));
@@ -375,6 +396,7 @@ export class FormService {
* @param taskId Task identifier
* @param field Field identifier
* @param column Column identifier
* @returns Field values
*/
getRestFieldValuesColumn(taskId: string, field: string, column?: string): Observable<any> {
return Observable.fromPromise(this.taskApi.getRestFieldValuesColumn(taskId, field, column)).catch(err => this.handleError(err));
@@ -383,6 +405,7 @@ export class FormService {
/**
* Returns a URL for the profile picture of a user.
* @param userId ID of the target user
* @returns URL string
*/
getUserProfileImageApi(userId: number): string {
return this.apiService.getInstance().activiti.userApi.getUserProfilePictureUrl(userId);
@@ -392,6 +415,7 @@ export class FormService {
* Gets a list of workflow users.
* @param filter Filter to select specific users
* @param groupId Group ID for the search
* @returns Array of users
*/
getWorkflowUsers(filter: string, groupId?: string): Observable<UserProcessModel[]> {
let option: any = {filter: filter};
@@ -413,6 +437,7 @@ export class FormService {
* Gets a list of groups in a workflow.
* @param filter Filter to select specific groups
* @param groupId Group ID for the search
* @returns Array of groups
*/
getWorkflowGroups(filter: string, groupId?: string): Observable<GroupModel[]> {
let option: any = {filter: filter};
@@ -427,6 +452,7 @@ export class FormService {
/**
* Gets the ID of a form.
* @param res Object representing a form
* @returns ID string
*/
getFormId(res: any): string {
let result = null;
@@ -441,6 +467,7 @@ export class FormService {
/**
* Creates a JSON representation of form data.
* @param res Object representing form data
* @returns JSON data
*/
toJson(res: any) {
if (res) {
@@ -452,6 +479,7 @@ export class FormService {
/**
* Creates a JSON array representation of form data.
* @param res Object representing form data
* @returns JSON data
*/
toJsonArray(res: any) {
if (res) {
@@ -463,6 +491,7 @@ export class FormService {
/**
* Reports an error message.
* @param error Data object with optional `message` and `status` fields for the error
* @returns Error message
*/
handleError(error: any): Observable<any> {
let errMsg = FormService.UNKNOWN_ERROR_MESSAGE;

11
lib/core/services/comment-content.service.ts
View File

@@ -31,6 +31,12 @@ export class CommentContentService {
private logService: LogService) {
}
/**
* Adds a comment to a node.
* @param nodeId ID of the target node
* @param message Text for the comment
* @returns Details of the comment added
*/
addNodeComment(nodeId: string, message: string): Observable<CommentModel> {
return Observable.fromPromise(this.apiService.getInstance().core.commentsApi.addComment(nodeId, {content: message}))
.map((response: any) => {
@@ -43,6 +49,11 @@ export class CommentContentService {
}).catch(err => this.handleError(err));
}
/**
* Gets all comments that have been added to a node.
* @param nodeId ID of the target node
* @returns Details for each comment
*/
getNodeComments(nodeId: string): Observable<CommentModel[]> {
return Observable.fromPromise(this.apiService.getInstance().core.commentsApi.getComments(nodeId))
.map((response: any) => {

49
lib/core/services/content.service.ts
View File

@@ -79,11 +79,8 @@ export class ContentService {
/**
* Invokes content download for a Blob with a file name.
*
* @param blob Content to download.
* @param fileName Name of the resulting file.
*
* @memberOf ContentService
*/
downloadBlob(blob: Blob, fileName: string): void {
this.saveData(blob, 'blob', fileName);
@@ -91,11 +88,8 @@ export class ContentService {
/**
* Invokes content download for a data array with a file name.
*
* @param data Data to download.
* @param fileName Name of the resulting file.
*
* @memberOf ContentService
*/
downloadData(data: any, fileName: string): void {
this.saveData(data, 'data', fileName);
@@ -103,11 +97,8 @@ export class ContentService {
/**
* Invokes content download for a JSON object with a file name.
*
* @param json JSON object to download.
* @param fileName Name of the resulting file.
*
* @memberOf ContentService
*/
downloadJSON(json: any, fileName: string): void {
this.saveData(json, 'json', fileName);
@@ -117,8 +108,7 @@ export class ContentService {
* Creates a trusted object URL from the Blob.
* WARNING: calling this method with untrusted user data exposes your application to XSS security risks!
* @param blob Data to wrap into object URL
*
* @memberOf ContentService
* @returns URL string
*/
createTrustedUrl(blob: Blob): string {
let url = window.URL.createObjectURL(blob);
@@ -130,11 +120,11 @@ export class ContentService {
}
/**
* Get thumbnail URL for the given document node.
*
* Gets a thumbnail URL for the given document node.
* @param node Node to get URL for.
* @param [attachment] Retrieve content as an attachment for download
* @param [ticket] Custom ticket to use for authentication
* @param attachment Toggles whether to retrieve content as an attachment for download
* @param ticket Custom ticket to use for authentication
* @returns URL string
*/
getDocumentThumbnailUrl(node: any, attachment?: boolean, ticket?: string): string {
@@ -146,11 +136,11 @@ export class ContentService {
}
/**
* Get content URL for the given node.
*
* @param nodeId or node to get URL for.
* @param [attachment] Retrieve content as an attachment for download
* @param [ticket] Custom ticket to use for authentication
* Gets a content URL for the given node.
* @param node Node to get URL for.
* @param attachment Toggles whether to retrieve content as an attachment for download
* @param ticket Custom ticket to use for authentication
* @returns URL string
*/
getContentUrl(node: any, attachment?: boolean, ticket?: string): string {
@@ -162,9 +152,9 @@ export class ContentService {
}
/**
* Get content for the given node.
* Gets content for the given node.
* @param nodeId ID of the target node
*
* @returns Content data
*/
getNodeContent(nodeId: string): Observable<any> {
return Observable.fromPromise(this.apiService.getInstance().core.nodesApi.getFileContent(nodeId).then((dataContent) => {
@@ -173,10 +163,11 @@ export class ContentService {
}
/**
* Create a folder
* Creates a folder.
* @param relativePath Location to create the folder
* @param name Folder name
* @param parentId Node ID of parent folder
* @returns Information about the new folder
*/
createFolder(relativePath: string, name: string, parentId?: string): Observable<FolderCreatedEvent> {
return Observable.fromPromise(this.apiService.getInstance().nodes.createFolder(name, relativePath, parentId))
@@ -193,8 +184,8 @@ export class ContentService {
/**
* Gets a Node via its node ID.
* @param nodeId
* @param opts
* @param nodeId ID of the target node
* @param opts Options supported by JSAPI
* @returns Details of the folder
*/
getNode(nodeId: string, opts?: any): Observable<NodeEntry> {
@@ -202,10 +193,10 @@ export class ContentService {
}
/**
* Check if the user has permissions on that node
* Checks if the user has permissions on that node
* @param node Node to check allowableOperations
* @param permission Create, delete, update, updatePermissions, !create, !delete, !update, !updatePermissions
*
* @returns True if the user has the required permissions, false otherwise
*/
hasPermission(node: Node, permission: PermissionsEnum | string): boolean {
let hasPermission = false;
@@ -239,9 +230,9 @@ export class ContentService {
}
/**
* Check if the node has the properties allowableOperations
* Checks if the node has the properties allowableOperations
* @param node Node to check allowableOperations
*
* @returns True if the node has the property, false otherwise
*/
hasAllowableOperations(node: any): boolean {
return node && node.allowableOperations ? true : false;

2
lib/core/services/dynamic-component-mapper.service.ts
View File

@@ -35,6 +35,7 @@ export abstract class DynamicComponentMapper {
* Gets the currently active ComponentTypeResolver function for a field type.
* @param type The type whose resolver you want
* @param defaultValue Default type returned for types that are not yet mapped
* @returns Resolver function
*/
getComponentTypeResolver(type: string, defaultValue: Type<{}> = this.defaultValue): DynamicComponentResolveFunction {
if (type) {
@@ -70,6 +71,7 @@ export abstract class DynamicComponentMapper {
* Finds the component type that is needed to render a form field.
* @param model [Form field model](form-field.model.md) for the field to render
* @param defaultValue Default type returned for field types that are not yet mapped.
* @returns Component type
*/
resolveComponentType(model: DynamicComponentModel, defaultValue: Type<{}> = this.defaultValue): Type<{}> {
if (model) {

6
lib/core/services/favorites-api.service.ts
View File

@@ -62,6 +62,12 @@ export class FavoritesApiService {
return this.apiService.getInstance().core.favoritesApi;
}
/**
* Gets the favorites for a user.
* @param personId ID of the user
* @param options Options supported by JSAPI
* @returns List of favorites
*/
getFavorites(personId: string, options?: any): Observable<NodePaging> {
const { favoritesApi, handleError } = this;
const defaultOptions = {

8
lib/core/userinfo/services/bpm-user.service.ts
View File

@@ -36,8 +36,8 @@ export class BpmUserService {
}
/**
* get Current User information for BPM
* @param userName - the user name
* Gets information about the current user.
* @returns User information object
*/
getCurrentUserInfo(): Observable<BpmUserModel> {
return Observable.fromPromise(this.apiService.getInstance().activiti.profileApi.getProfile())
@@ -45,6 +45,10 @@ export class BpmUserService {
.catch(err => this.handleError(err));
}
/**
* Gets the current user's profile image as a URL.
* @returns URL string
*/
getCurrentUserProfileImage(): string {
return this.apiService.getInstance().activiti.profileApi.getProfilePictureUrl();
}