Gist¶
A GitHub gist. Contains the gist's metadata, file listing, and URLs for related resources. Provides convenience methods for updating, deleting, forking, starring, and accessing comments and commit history.
The files field is an array of (filename, GistFile) pairs rather than a
map, preserving insertion order. Gists typically have few files, so linear
lookup is not a concern.
Constructors¶
create¶
new val create(
creds: Credentials val,
id': String val,
node_id': String val,
description': (String val | None val),
public': Bool val,
owner': (User val | None val),
user': (User val | None val),
files': Array[(String val , GistFile val)] val,
comments': I64 val,
comments_enabled': Bool val,
truncated': Bool val,
created_at': String val,
updated_at': String val,
url': String val,
html_url': String val,
forks_url': String val,
commits_url': String val,
comments_url': String val,
git_pull_url': String val,
git_push_url': String val)
: Gist val^
Parameters¶
- creds: Credentials val
- id': String val
- node_id': String val
- description': (String val | None val)
- public': Bool val
- owner': (User val | None val)
- user': (User val | None val)
- files': Array[(String val , GistFile val)] val
- comments': I64 val
- comments_enabled': Bool val
- truncated': Bool val
- created_at': String val
- updated_at': String val
- url': String val
- html_url': String val
- forks_url': String val
- commits_url': String val
- comments_url': String val
- git_pull_url': String val
- git_push_url': String val
Returns¶
- Gist val^
Public fields¶
let id: String val¶
let node_id: String val¶
let description: (String val | None val)¶
let public: Bool val¶
let owner: (User val | None val)¶
let user: (User val | None val)¶
let files: Array[(String val , GistFile val)] val¶
let comments: I64 val¶
let comments_enabled: Bool val¶
let truncated: Bool val¶
let created_at: String val¶
let updated_at: String val¶
let url: String val¶
let html_url: String val¶
let forks_url: String val¶
let commits_url: String val¶
let comments_url: String val¶
let git_pull_url: String val¶
let git_push_url: String val¶
Public Functions¶
update_gist¶
Updates this gist's files and/or description.
fun box update_gist(
update_files: Array[(String val , (GistFileEdit val | GistFileRename val | GistFileDelete val))] val,
new_description: (String val | None val) = reference)
: Promise[(Gist val | RequestError val)] tag
Parameters¶
- update_files: Array[(String val , (GistFileEdit val | GistFileRename val | GistFileDelete val))] val
- new_description: (String val | None val) = reference
Returns¶
- Promise[(Gist val | RequestError val)] tag
delete_gist¶
Deletes this gist.
Returns¶
- Promise[(Deleted val | RequestError val)] tag
get_revision¶
Fetches a specific revision of this gist by its commit SHA.
Parameters¶
- sha: String val
Returns¶
- Promise[(Gist val | RequestError val)] tag
fork¶
Forks this gist into the authenticated user's account.
Returns¶
- Promise[(Gist val | RequestError val)] tag
get_forks¶
Lists forks of this gist as a paginated list.
Returns¶
- Promise[(PaginatedList[Gist val] val | RequestError val)] tag
get_commits¶
Lists commits for this gist as a paginated list.
Returns¶
- Promise[(PaginatedList[GistCommit val] val | RequestError val)] tag
star¶
Stars this gist for the authenticated user.
Returns¶
- Promise[(Deleted val | RequestError val)] tag
unstar¶
Unstars this gist for the authenticated user.
Returns¶
- Promise[(Deleted val | RequestError val)] tag
is_starred¶
Checks whether this gist is starred by the authenticated user.
Returns¶
- Promise[(Bool val | RequestError val)] tag
create_comment¶
Creates a new comment on this gist.
Parameters¶
- body: String val
Returns¶
- Promise[(GistComment val | RequestError val)] tag
get_comments¶
Lists comments on this gist as a paginated list.
Returns¶
- Promise[(PaginatedList[GistComment val] val | RequestError val)] tag