Class Attachment

Hierarchy

ChallongeBase
- Attachment

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Attachment(api_key: string, baseUrl: string, match_id: number, id: number, data?: matchAttachmentResponseObject): Attachment

Inherited from ChallongeBase.constructor
- Defined in attachment.ts:13
Parameters
- api_key: string
- baseUrl: string
- match_id: number
- id: number
- Optional data: matchAttachmentResponseObject
Returns Attachment

Properties

api_key

api_key: string

Optional asset_content_type

asset_content_type: string

Optional asset_file_name

asset_file_name: string

Optional asset_file_size

asset_file_size: number

Optional asset_url

asset_url: string

baseUrl

baseUrl: string

Optional created_at

created_at: Date

Optional description

description: string

id

id: number

match_id

match_id: number

Optional original_file_name

original_file_name: string

Optional updated_at

updated_at: Date

Optional url

url: string

user_id

user_id: number

Methods

delete

delete(): Promise<boolean>

- Defined in attachment.ts:44
Delete a match attachment.

Returns Promise<boolean>

get

get(): Promise<Attachment>

- Defined in attachment.ts:24
Retrieve a single match attachment record.

Returns Promise<Attachment>

update

update(params?: matchAttachmentRequestObject): Promise<Attachment>

- Defined in attachment.ts:34
Update the attributes of a match attachment.

Parameters
- Optional params: matchAttachmentRequestObject
Returns Promise<Attachment>

Generated using TypeDoc