Class Files

Hierarchy

UrlSection
- Files

Index

Constructors

constructor

Methods

Constructors

constructor

new Files(prv: PathSegment, id?: string, service?: any): Files

Overrides UrlSection.constructor
- Defined in paths/Files.ts:5
Parameters
- prv: PathSegment
- Optional id: string
- Optional service: any
Returns Files

Methods

get

get(): Promise<PostGlipFile>

- Defined in paths/Files.ts:26
Since 1.0.31 (Release 9.2)
Returns a file.
Required Permissions
Permission Description
Glip Availability of Glip
API Group
Medium

Returns Promise<PostGlipFile>

getEndpoint

getEndpoint(withValue?: boolean): string

Inherited from UrlSection.getEndpoint
- Defined in PathSegment.ts:26
Parameters
- Default value withValue: boolean = true
Returns string

Protected getRest

getRest(): RestClient

Inherited from UrlSection.getRest
- Defined in PathSegment.ts:34
Returns RestClient

post

post(query?: PostQuery): Promise<PostGlipFile>

- Defined in paths/Files.ts:13
Since 1.0.31 (Release 9.2)
Posts a file.
Required Permissions
Permission Description
Glip Availability of Glip
API Group
Heavy

Parameters
- Optional query: PostQuery
Returns Promise<PostGlipFile>

toString

toString(withValue?: boolean): string

Inherited from UrlSection.toString
- Defined in PathSegment.ts:18
Parameters
- Default value withValue: boolean = true
Returns string

Generated using TypeDoc