diff --git a/reference.md b/reference.md index c52cd15..092b29d 100644 --- a/reference.md +++ b/reference.md @@ -69,7 +69,7 @@ Creates a new Cohost API client. Requires no arguments. ##### Defined in -[index.ts:400](https://github.com/ApexDevelopment/cohost-api/blob/474e7a1/index.ts#L400) +[index.ts:401](https://github.com/ApexDevelopment/cohost-api/blob/f4cad2e/index.ts#L401) ### Properties @@ -77,11 +77,11 @@ Creates a new Cohost API client. Requires no arguments. • **loggedIn**: `boolean` = `false` -Whether the client is logged in.. +Whether the client is logged in. ##### Defined in -[index.ts:392](https://github.com/ApexDevelopment/cohost-api/blob/474e7a1/index.ts#L392) +[index.ts:393](https://github.com/ApexDevelopment/cohost-api/blob/f4cad2e/index.ts#L393) ___ @@ -93,7 +93,7 @@ The session token for the client. ##### Defined in -[index.ts:390](https://github.com/ApexDevelopment/cohost-api/blob/474e7a1/index.ts#L390) +[index.ts:391](https://github.com/ApexDevelopment/cohost-api/blob/f4cad2e/index.ts#L391) ___ @@ -105,7 +105,7 @@ The currently logged in user. Once logged in, can be used to access the user's i ##### Defined in -[index.ts:395](https://github.com/ApexDevelopment/cohost-api/blob/474e7a1/index.ts#L395) +[index.ts:396](https://github.com/ApexDevelopment/cohost-api/blob/f4cad2e/index.ts#L396) ### Methods @@ -130,7 +130,7 @@ The logged in User, or null if the login failed. ##### Defined in -[index.ts:422](https://github.com/ApexDevelopment/cohost-api/blob/474e7a1/index.ts#L422) +[index.ts:423](https://github.com/ApexDevelopment/cohost-api/blob/f4cad2e/index.ts#L423) @@ -172,7 +172,7 @@ This class is not used for creating posts. Instead, use the PostBuilder class to ##### Defined in -[index.ts:26](https://github.com/ApexDevelopment/cohost-api/blob/474e7a1/index.ts#L26) +[index.ts:26](https://github.com/ApexDevelopment/cohost-api/blob/f4cad2e/index.ts#L26) ___ @@ -182,7 +182,7 @@ ___ ##### Defined in -[index.ts:25](https://github.com/ApexDevelopment/cohost-api/blob/474e7a1/index.ts#L25) +[index.ts:25](https://github.com/ApexDevelopment/cohost-api/blob/f4cad2e/index.ts#L25) ___ @@ -192,7 +192,7 @@ ___ ##### Defined in -[index.ts:24](https://github.com/ApexDevelopment/cohost-api/blob/474e7a1/index.ts#L24) +[index.ts:24](https://github.com/ApexDevelopment/cohost-api/blob/f4cad2e/index.ts#L24) @@ -207,6 +207,7 @@ Example usage: ```ts let postBuilder = new PostBuilder("Hello, world!"); postBuilder.addMarkdownBlock("This is a test post from cohost-api."); +postBuilder.addTag("cohost-api"); let finishedPost = postBuilder.build(); ``` @@ -245,7 +246,7 @@ Creates a new PostBuilder, used for easily constructing a Post object. ##### Defined in -[index.ts:147](https://github.com/ApexDevelopment/cohost-api/blob/474e7a1/index.ts#L147) +[index.ts:148](https://github.com/ApexDevelopment/cohost-api/blob/f4cad2e/index.ts#L148) ### Methods @@ -270,7 +271,7 @@ The PostBuilder object, for chaining. ##### Defined in -[index.ts:158](https://github.com/ApexDevelopment/cohost-api/blob/474e7a1/index.ts#L158) +[index.ts:159](https://github.com/ApexDevelopment/cohost-api/blob/f4cad2e/index.ts#L159) ___ @@ -294,7 +295,7 @@ The PostBuilder object, for chaining. ##### Defined in -[index.ts:180](https://github.com/ApexDevelopment/cohost-api/blob/474e7a1/index.ts#L180) +[index.ts:181](https://github.com/ApexDevelopment/cohost-api/blob/f4cad2e/index.ts#L181) ___ @@ -318,7 +319,7 @@ The PostBuilder object, for chaining. ##### Defined in -[index.ts:170](https://github.com/ApexDevelopment/cohost-api/blob/474e7a1/index.ts#L170) +[index.ts:171](https://github.com/ApexDevelopment/cohost-api/blob/f4cad2e/index.ts#L171) ___ @@ -342,7 +343,7 @@ The PostBuilder object, for chaining. ##### Defined in -[index.ts:190](https://github.com/ApexDevelopment/cohost-api/blob/474e7a1/index.ts#L190) +[index.ts:191](https://github.com/ApexDevelopment/cohost-api/blob/f4cad2e/index.ts#L191) ___ @@ -360,7 +361,7 @@ The Post object. ##### Defined in -[index.ts:199](https://github.com/ApexDevelopment/cohost-api/blob/474e7a1/index.ts#L199) +[index.ts:200](https://github.com/ApexDevelopment/cohost-api/blob/f4cad2e/index.ts#L200) @@ -408,7 +409,7 @@ Do not instantiate this class directly. Projects can only be obtained from the A ##### Defined in -[index.ts:231](https://github.com/ApexDevelopment/cohost-api/blob/474e7a1/index.ts#L231) +[index.ts:232](https://github.com/ApexDevelopment/cohost-api/blob/f4cad2e/index.ts#L232) ___ @@ -418,7 +419,7 @@ ___ ##### Defined in -[index.ts:224](https://github.com/ApexDevelopment/cohost-api/blob/474e7a1/index.ts#L224) +[index.ts:225](https://github.com/ApexDevelopment/cohost-api/blob/f4cad2e/index.ts#L225) ___ @@ -428,7 +429,7 @@ ___ ##### Defined in -[index.ts:222](https://github.com/ApexDevelopment/cohost-api/blob/474e7a1/index.ts#L222) +[index.ts:223](https://github.com/ApexDevelopment/cohost-api/blob/f4cad2e/index.ts#L223) ___ @@ -438,7 +439,7 @@ ___ ##### Defined in -[index.ts:223](https://github.com/ApexDevelopment/cohost-api/blob/474e7a1/index.ts#L223) +[index.ts:224](https://github.com/ApexDevelopment/cohost-api/blob/f4cad2e/index.ts#L224) ___ @@ -448,7 +449,7 @@ ___ ##### Defined in -[index.ts:221](https://github.com/ApexDevelopment/cohost-api/blob/474e7a1/index.ts#L221) +[index.ts:222](https://github.com/ApexDevelopment/cohost-api/blob/f4cad2e/index.ts#L222) ___ @@ -458,7 +459,7 @@ ___ ##### Defined in -[index.ts:230](https://github.com/ApexDevelopment/cohost-api/blob/474e7a1/index.ts#L230) +[index.ts:231](https://github.com/ApexDevelopment/cohost-api/blob/f4cad2e/index.ts#L231) ___ @@ -468,7 +469,7 @@ ___ ##### Defined in -[index.ts:220](https://github.com/ApexDevelopment/cohost-api/blob/474e7a1/index.ts#L220) +[index.ts:221](https://github.com/ApexDevelopment/cohost-api/blob/f4cad2e/index.ts#L221) ___ @@ -478,7 +479,7 @@ ___ ##### Defined in -[index.ts:226](https://github.com/ApexDevelopment/cohost-api/blob/474e7a1/index.ts#L226) +[index.ts:227](https://github.com/ApexDevelopment/cohost-api/blob/f4cad2e/index.ts#L227) ___ @@ -488,7 +489,7 @@ ___ ##### Defined in -[index.ts:225](https://github.com/ApexDevelopment/cohost-api/blob/474e7a1/index.ts#L225) +[index.ts:226](https://github.com/ApexDevelopment/cohost-api/blob/f4cad2e/index.ts#L226) ___ @@ -498,7 +499,7 @@ ___ ##### Defined in -[index.ts:219](https://github.com/ApexDevelopment/cohost-api/blob/474e7a1/index.ts#L219) +[index.ts:220](https://github.com/ApexDevelopment/cohost-api/blob/f4cad2e/index.ts#L220) ___ @@ -508,7 +509,7 @@ ___ ##### Defined in -[index.ts:227](https://github.com/ApexDevelopment/cohost-api/blob/474e7a1/index.ts#L227) +[index.ts:228](https://github.com/ApexDevelopment/cohost-api/blob/f4cad2e/index.ts#L228) ___ @@ -518,7 +519,7 @@ ___ ##### Defined in -[index.ts:229](https://github.com/ApexDevelopment/cohost-api/blob/474e7a1/index.ts#L229) +[index.ts:230](https://github.com/ApexDevelopment/cohost-api/blob/f4cad2e/index.ts#L230) ___ @@ -528,7 +529,7 @@ ___ ##### Defined in -[index.ts:228](https://github.com/ApexDevelopment/cohost-api/blob/474e7a1/index.ts#L228) +[index.ts:229](https://github.com/ApexDevelopment/cohost-api/blob/f4cad2e/index.ts#L229) ### Methods @@ -552,7 +553,7 @@ The post with its postId set. ##### Defined in -[index.ts:299](https://github.com/ApexDevelopment/cohost-api/blob/474e7a1/index.ts#L299) +[index.ts:300](https://github.com/ApexDevelopment/cohost-api/blob/f4cad2e/index.ts#L300) ___ @@ -576,7 +577,7 @@ The post with its postId set. ##### Defined in -[index.ts:287](https://github.com/ApexDevelopment/cohost-api/blob/474e7a1/index.ts#L287) +[index.ts:288](https://github.com/ApexDevelopment/cohost-api/blob/f4cad2e/index.ts#L288) ___ @@ -598,7 +599,7 @@ Deletes a post from the project. ##### Defined in -[index.ts:310](https://github.com/ApexDevelopment/cohost-api/blob/474e7a1/index.ts#L310) +[index.ts:311](https://github.com/ApexDevelopment/cohost-api/blob/f4cad2e/index.ts#L311) ___ @@ -620,7 +621,7 @@ Gives a like from this project to a post. ##### Defined in -[index.ts:339](https://github.com/ApexDevelopment/cohost-api/blob/474e7a1/index.ts#L339) +[index.ts:340](https://github.com/ApexDevelopment/cohost-api/blob/f4cad2e/index.ts#L340) ___ @@ -642,7 +643,7 @@ Removes a like from this project to a post. ##### Defined in -[index.ts:351](https://github.com/ApexDevelopment/cohost-api/blob/474e7a1/index.ts#L351) +[index.ts:352](https://github.com/ApexDevelopment/cohost-api/blob/f4cad2e/index.ts#L352) ___ @@ -665,7 +666,7 @@ Updates a post in the project. ##### Defined in -[index.ts:323](https://github.com/ApexDevelopment/cohost-api/blob/474e7a1/index.ts#L323) +[index.ts:324](https://github.com/ApexDevelopment/cohost-api/blob/f4cad2e/index.ts#L324) @@ -696,7 +697,7 @@ The email address of this user. ##### Defined in -[index.ts:373](https://github.com/ApexDevelopment/cohost-api/blob/474e7a1/index.ts#L373) +[index.ts:374](https://github.com/ApexDevelopment/cohost-api/blob/f4cad2e/index.ts#L374) ___ @@ -708,7 +709,7 @@ The unique ID of this user. ##### Defined in -[index.ts:371](https://github.com/ApexDevelopment/cohost-api/blob/474e7a1/index.ts#L371) +[index.ts:372](https://github.com/ApexDevelopment/cohost-api/blob/f4cad2e/index.ts#L372) ___ @@ -720,7 +721,7 @@ The projects that this user is able to edit. ##### Defined in -[index.ts:369](https://github.com/ApexDevelopment/cohost-api/blob/474e7a1/index.ts#L369) +[index.ts:370](https://github.com/ApexDevelopment/cohost-api/blob/f4cad2e/index.ts#L370) # Enums @@ -748,7 +749,7 @@ Whether a post is a draft or published. ##### Defined in -[index.ts:12](https://github.com/ApexDevelopment/cohost-api/blob/474e7a1/index.ts#L12) +[index.ts:12](https://github.com/ApexDevelopment/cohost-api/blob/f4cad2e/index.ts#L12) ___ @@ -758,4 +759,4 @@ ___ ##### Defined in -[index.ts:13](https://github.com/ApexDevelopment/cohost-api/blob/474e7a1/index.ts#L13) +[index.ts:13](https://github.com/ApexDevelopment/cohost-api/blob/f4cad2e/index.ts#L13)