GHKGist Class Reference

Inherits from	NSObject
Conforms to	GHKObject
Declared in	GHKGist.h GHKGist.m

Overview

A class describes a gist

Tasks

Other Methods

isPublic
Is the gist public
property
isStarred
Is the gist starred
property
comments
Number of comments
property
user
The user who wrote the gist
property
createdAt
Date created at
property
updatedAt
Date updated at
property
deletedFiles
Array of deleted GHKGistFile while editing
property
files
Array of GHKGistFile
property
gistDescription
Description of gist
property
gistId
Gist ID
property
gitPullUrl
Git Pull URL
property
gitPushUrl
Git Push URL
property
htmlUrl
HTML URL
property
url
Single gist API URL
property
isNew
Is the gist stored on the web
property

Initialization

– initEmpty
Initialize new empty gist

File manipulation

– addEmptyFile
Creates an empty file and adds to files
– createEmptyFile
Creates an empty file without adding
– deleteFile:
Delete the file
– fileWithFilename:
Find a file by filename

Other Methods

– dictionary
JSON object as a NSDictionary to post to API
– initWithDictionary:
Initialize a new instance from JSON object as a NSDictionary

Properties

comments

Number of comments

@property (nonatomic) NSInteger comments

Declared In

GHKGist.h

createdAt

Date created at

@property (nonatomic, strong) NSDate *createdAt

Declared In

GHKGist.h

deletedFiles

Array of deleted GHKGistFile while editing

@property (nonatomic, strong) NSMutableArray *deletedFiles

Declared In

GHKGist.h

files

Array of GHKGistFile

@property (nonatomic, strong) NSMutableArray *files

Declared In

GHKGist.h

gistDescription

Description of gist

@property (nonatomic, strong) NSString *gistDescription

Declared In

GHKGist.h

gistId

Gist ID

@property (nonatomic, strong) NSString *gistId

Declared In

GHKGist.h

gitPullUrl

Git Pull URL

@property (nonatomic, strong) NSURL *gitPullUrl

Declared In

GHKGist.h

gitPushUrl

Git Push URL

@property (nonatomic, strong) NSURL *gitPushUrl

Declared In

GHKGist.h

htmlUrl

HTML URL

@property (nonatomic, strong) NSURL *htmlUrl

Declared In

GHKGist.h

isNew

Is the gist stored on the web

@property (nonatomic, readonly) BOOL isNew

Declared In

GHKGist.h

isPublic

Is the gist public

@property (nonatomic) BOOL isPublic

Declared In

GHKGist.h

isStarred

Is the gist starred

@property (nonatomic) BOOL isStarred

Declared In

GHKGist.h

updatedAt

Date updated at

@property (nonatomic, strong) NSDate *updatedAt

Declared In

GHKGist.h

url

Single gist API URL

@property (nonatomic, strong) NSURL *url

Declared In

GHKGist.h

user

The user who wrote the gist

@property (nonatomic, strong) GHKUser *user

Declared In

GHKGist.h

Instance Methods

addEmptyFile

Creates an empty file and adds to files

- (GHKGistFile *)addEmptyFile

Return Value

the file created

Declared In

GHKGist.h

createEmptyFile

Creates an empty file without adding

- (GHKGistFile *)createEmptyFile

Return Value

the file created

Declared In

GHKGist.h

deleteFile:

Delete the file

- (void)deleteFile:(GHKGistFile *)file

Declared In

GHKGist.h

dictionary

JSON object as a NSDictionary to post to API

- (NSDictionary *)dictionary

Return Value

The NSDictionary

Declared In

GHKObject.h

fileWithFilename:

Find a file by filename

- (GHKGistFile *)fileWithFilename:(NSString *)filename

Return Value

the file found

Declared In

GHKGist.h

initEmpty

Initialize new empty gist

- (id)initEmpty

Declared In

GHKGist.h

initWithDictionary:

Initialize a new instance from JSON object as a NSDictionary

- (id)initWithDictionary:(NSDictionary *)dictionary

Declared In

GHKObject.h