Class FolderApi

Hierarchy

BaseAPI
- FolderApi

Index

Constructors

Properties

Methods

getFolderAcl getFolderAclRaw request share shareRaw unShare unShareRaw withMiddleware withPostMiddleware withPreMiddleware

Constructors

constructor

new FolderApi(configuration?: Configuration): FolderApi
Parameters
- configuration: Configuration = DefaultConfig
Returns FolderApi
Inherited from BaseAPI.constructor
- Defined in runtime.ts:96

Properties

`Protected` configuration

configuration: Configuration = DefaultConfig

Methods

getFolderAcl

getFolderAcl(requestParameters: GetFolderAclRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTAclInfo>
Get access control list (ACL) by folder ID.
Parameters
- requestParameters: GetFolderAclRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTAclInfo>
- Defined in apis/FolderApi.ts:81

getFolderAclRaw

getFolderAclRaw(requestParameters: GetFolderAclRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTAclInfo>>
Get access control list (ACL) by folder ID.
Parameters
- requestParameters: GetFolderAclRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTAclInfo>>
- Defined in apis/FolderApi.ts:51

`Protected` request

request(context: RequestOpts, initOverrides?: RequestInit | InitOverrideFunction): Promise<Response>
Parameters
- context: RequestOpts
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<Response>
Inherited from BaseAPI.request
- Defined in runtime.ts:116

share

share(requestParameters: ShareRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTAclInfo>
Share folder by folder ID.
Parameters
- requestParameters: ShareRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTAclInfo>
- Defined in apis/FolderApi.ts:126

shareRaw

shareRaw(requestParameters: ShareRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTAclInfo>>
Share folder by folder ID.
Parameters
- requestParameters: ShareRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTAclInfo>>
- Defined in apis/FolderApi.ts:89

unShare

unShare(requestParameters: UnShareRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<object>
Unshare folder by folder ID and tab ID.
Parameters
- requestParameters: UnShareRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<object>
- Defined in apis/FolderApi.ts:172

unShareRaw

unShareRaw(requestParameters: UnShareRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<object>>
Unshare folder by folder ID and tab ID.
Parameters
- requestParameters: UnShareRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<object>>
- Defined in apis/FolderApi.ts:134

withMiddleware

withMiddleware<T>(this: T, ...middlewares: Middleware[]): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...middlewares: Middleware[]
Returns T
Inherited from BaseAPI.withMiddleware
- Defined in runtime.ts:100

withPostMiddleware

withPostMiddleware<T>(this: T, ...postMiddlewares: ((context: ResponseContext) => Promise<void | Response>)[]): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...postMiddlewares: ((context: ResponseContext) => Promise<void | Response>)[]
Returns T
Inherited from BaseAPI.withPostMiddleware
- Defined in runtime.ts:111

withPreMiddleware

withPreMiddleware<T>(this: T, ...preMiddlewares: ((context: RequestContext) => Promise<void | FetchParams>)[]): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...preMiddlewares: ((context: RequestContext) => Promise<void | FetchParams>)[]
Returns T
Inherited from BaseAPI.withPreMiddleware
- Defined in runtime.ts:106

Generated using TypeDoc