alfresco-ng2-components/lib/core/services/shared-links-api.service.ts
Andy Stark dd1b8893cc [ADF-2905] Added JSDocs for core (#3281)
* [ADF-2905] Updated JSDocs for core

* [ADF-2905] Added missing JSDoc for user pref service
2018-05-08 15:30:23 +01:00

92 lines
3.0 KiB
TypeScript

/*!
* @license
* Copyright 2016 Alfresco Software, Ltd.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { Injectable } from '@angular/core';
import { NodePaging, SharedLinkEntry } from 'alfresco-js-api';
import { Observable } from 'rxjs/Observable';
import { AlfrescoApiService } from './alfresco-api.service';
import { UserPreferencesService } from './user-preferences.service';
import 'rxjs/add/observable/fromPromise';
@Injectable()
export class SharedLinksApiService {
constructor(private apiService: AlfrescoApiService,
private preferences: UserPreferencesService) {
}
private get sharedLinksApi() {
return this.apiService.getInstance().core.sharedlinksApi;
}
/**
* Gets shared links available to the current user.
* @param options Options supported by JSAPI
* @returns List of shared links
*/
getSharedLinks(options: any = {}): Observable<NodePaging> {
const { sharedLinksApi, handleError } = this;
const defaultOptions = {
maxItems: this.preferences.paginationSize,
skipCount: 0,
include: ['properties', 'allowableOperations']
};
const queryOptions = Object.assign({}, defaultOptions, options);
const promise = sharedLinksApi
.findSharedLinks(queryOptions);
return Observable
.fromPromise(promise)
.catch(handleError);
}
/**
* Creates a shared link available to the current user.
* @param nodeId ID of the node to link to
* @param options Options supported by JSAPI
* @returns The shared link just created
*/
createSharedLinks(nodeId: string, options: any = {}): Observable<SharedLinkEntry> {
const { sharedLinksApi, handleError } = this;
const promise = sharedLinksApi.addSharedLink({ nodeId: nodeId });
return Observable
.fromPromise(promise)
.catch(handleError);
}
/**
* Deletes a shared link.
* @param sharedId ID of the link to delete
* @returns Null response notifying when the operation is complete
*/
deleteSharedLink(sharedId: string): Observable<SharedLinkEntry> {
const { sharedLinksApi, handleError } = this;
const promise = sharedLinksApi.deleteSharedLink(sharedId);
return Observable
.fromPromise(promise)
.catch(handleError);
}
private handleError(error: any): Observable<any> {
return Observable.of(error);
}
}