@alfresco/js-api 10.2.0-30612540894 → 10.2.0-30804668708

package/typings/src/api/model-rest-api/api/types.api.d.ts

@@ -56,6 +56,7 @@ export declare class TypesApi extends BaseApi {
      * Get a type
      *
      * **Note:** This is available in Alfresco 7.0.0 and newer versions.
+     *
      * @param typeId The `Qname` of a type(prefix:name) e.g 'cm:content'
      * @returns Promise<TypeEntry>
      */
@@ -64,6 +65,7 @@ export declare class TypesApi extends BaseApi {
      * List types
      *
      * **Note:** This is available in Alfresco 7.0.0 and newer versions.
+     *
      * @param opts Optional parameters
      * @returns Promise<TypePaging>
      */

package/typings/src/api/search-rest-api/api/search.api.d.ts

@@ -20,6 +20,7 @@ import { ApiClient } from '../../../api-clients/api-client';
 import { LegacyHttpClient } from '../../../api-clients/http-client.interface';
 /**
  * Search service.
+ *
  * @module SearchApi
  */
 export declare class SearchApi extends ApiClient {
@@ -28,6 +29,7 @@ export declare class SearchApi extends ApiClient {
      * Searches Alfresco
      *
      * **Note**: this endpoint is available in Alfresco 5.2 and newer versions.
+     *
      * @param queryBody Generic query API
      * @returns Promise<ResultSetPaging>
      */

package/typings/src/assert.d.ts

@@ -16,6 +16,7 @@
  */
 /**
  * Throw exception if param is not defined
+ *
  * @param param param
  * @param name param name
  */

package/typings/src/authentication/contentAuth.d.ts

@@ -30,6 +30,7 @@ export declare class ContentAuth extends AlfrescoApiClient {
     saveUsername(username: string): void;
     /**
      * login Alfresco API
+     *
      * @param  username Username to login
      * @param  password Password to login
      * @returns A promise that returns {new authentication ticket} if resolved and {error} if rejected.
@@ -37,11 +38,13 @@ export declare class ContentAuth extends AlfrescoApiClient {
     login(username: string, password: string): Promise<string>;
     /**
      * validate the ticket present in this.config.ticket against the server
+     *
      * @returns A promise that returns  if resolved and {error} if rejected.
      */
     validateTicket(): Promise<string>;
     /**
      * logout Alfresco API
+     *
      * @returns A promise that returns { authentication ticket} if resolved and {error} if rejected.
      */
     logout(): Promise<void>;
@@ -51,17 +54,20 @@ export declare class ContentAuth extends AlfrescoApiClient {
     setTicket(ticket: string): void;
     /**
      * Get the current Ticket
+     *
      * @returns ticket value
      */
     getTicket(): string;
     invalidateSession(): void;
     /**
      * If the client is logged in return true
+     *
      * @returns `true` if client is logged in, otherwise `false`
      */
     isLoggedIn(): boolean;
     /**
      * return the Authentication
+     *
      * @returns authentication object
      */
     getAuthentication(): Authentication;

package/typings/src/authentication/oauth2Auth.d.ts

@@ -83,6 +83,7 @@ export declare class Oauth2Auth extends AlfrescoApiClient {
     destroyIframe(): void;
     /**
      * login Alfresco API
+     *
      * @returns A promise that returns {new authentication token} if resolved and {error} if rejected.
      */
     login(username: string, password: string): Promise<any>;
@@ -90,6 +91,7 @@ export declare class Oauth2Auth extends AlfrescoApiClient {
     pollingRefreshToken(): void;
     /**
      * Refresh the Token
+     *
      * @returns promise of void
      */
     refreshToken(): Promise<any>;
@@ -100,11 +102,13 @@ export declare class Oauth2Auth extends AlfrescoApiClient {
     setToken(token: string, refreshToken: string): void;
     /**
      * Get the current Token
+     *
      * @returns token value
      */
     getToken(): string;
     /**
      * return the Authentication
+     *
      * @returns authentications
      */
     getAuthentication(): Authentication;
@@ -114,6 +118,7 @@ export declare class Oauth2Auth extends AlfrescoApiClient {
     changeHost(host: string): void;
     /**
      * If the client is logged in return true
+     *
      * @returns is logged in
      */
     isLoggedIn(): boolean;

package/typings/src/authentication/processAuth.d.ts

@@ -28,6 +28,7 @@ export declare class ProcessAuth extends AlfrescoApiClient {
     saveUsername(username: string): void;
     /**
      * login Activiti API
+     *
      * @param username Username to login
      * @param password Password to login
      * @returns A promise that returns {new authentication ticket} if resolved and {error} if rejected.
@@ -35,27 +36,32 @@ export declare class ProcessAuth extends AlfrescoApiClient {
     login(username: string, password: string): AlfrescoApiClientPromise<string>;
     /**
      * logout Alfresco API
+     *
      * @returns A promise that returns {new authentication ticket} if resolved and {error} if rejected.
      */
     logout(): AlfrescoApiClientPromise<void>;
     /**
      * Set the current Ticket
+     *
      * @param ticket Ticket value
      */
     setTicket(ticket: string): void;
     invalidateSession(): void;
     /**
      * Get the current Ticket
+     *
      * @returns ticket
      */
     getTicket(): string;
     /**
      * If the client is logged in return true
+     *
      * @returns `true` if logged in, otherwise `false`
      */
     isLoggedIn(): boolean;
     /**
      * return the Authentication
+     *
      * @returns authentication object
      */
     getAuthentication(): Authentication;

package/typings/src/contentClient.d.ts

@@ -26,6 +26,7 @@ export declare class ContentClient extends AlfrescoApiClient {
     changeHost(): void;
     /**
      * set the Authentications
+     *
      * @param authentications authentications
      */
     setAuthentications(authentications: Authentication): void;

package/typings/src/processClient.d.ts

@@ -25,6 +25,7 @@ export declare class ProcessClient extends AlfrescoApiClient {
     changeHost(): void;
     /**
      * set the authentications
+     *
      * @param authentications Authentications value
      */
     setAuthentications(authentications: Authentication): void;

package/typings/src/utils/lazy-api.d.ts

@@ -16,6 +16,7 @@
  */
 /**
  * LazyApi is a decorator that creates a lazy-loaded API instance.
+ *
  * @param factory - A function that creates the API instance.
  * @returns A decorator function that can be used to decorate a class property.
  */

package/typings/src/utils/param-to-string.d.ts

@@ -16,6 +16,7 @@
  */
 /**
  * Returns a string representation for an actual parameter.
+ *
  * @param param The actual parameter.
  * @returns The string representation of <code>param</code>.
  */