Class Posts

Hierarchy

UrlSection
- Posts

Index

Constructors

constructor

Methods

Constructors

constructor

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

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

Methods

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

list

list(query?: ListQuery): Promise<GlipPosts>

- Defined in paths/Posts.ts:15
Since 1.0.28 (Release 8.4)
Returns list of posts.
Required Permissions
Permission Description
Glip Availability of Glip
API Group
Light

Parameters
- Optional query: ListQuery
Returns Promise<GlipPosts>

post

post(body: GlipCreatePost): Promise<GlipPostInfo>

- Defined in paths/Posts.ts:28
Since 1.0.28 (Release 8.4)
Creates a post.
Required Permissions
Permission Description
Glip Availability of Glip
API Group
Light

Parameters
- body: GlipCreatePost
Returns Promise<GlipPostInfo>

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