Skip to content
This repository was archived by the owner on Jan 5, 2019. It is now read-only.

Commit fbb6c8b

Browse files
authored
Update readme
1 parent 61a243c commit fbb6c8b

1 file changed

Lines changed: 26 additions & 1 deletion

File tree

README.md

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ Additionally you can call `getScore()` which calculates the total score.
4848

4949
### Rant
5050
Rants are get through one of the methods in `DevRant`, or by an id (`Rant.byId(id)`).
51-
This will throw a `NoSuchRantException` if the id is invalid.
51+
The latter will throw a `NoSuchRantException` if the id is invalid.
5252
In addition to the `RantContent` attributes, a `Rant` also contains:
5353

5454
- tags
@@ -72,6 +72,31 @@ Comment[] comments = rant.getComments();
7272
boolean success = rant.fetchComments(true);
7373
```
7474

75+
### Collab
76+
Collabs are an extension of rants.
77+
They are get through `DevRant.collabs()` or by an id (`Collab.byId(id)`).
78+
The latter will throw a `NoSuchRantException` if the id is invalid, or a `NotACollabException` if it is simply a rant instead of a collab.
79+
Besides the attributes from a rant, collabs have the following attributes:
80+
81+
- projectType
82+
- description
83+
- techStack
84+
- teamSize
85+
- url
86+
87+
Like with a rant the comments can be fetched or force fetched.
88+
There is also more data which needs to be fetched, similar to the comments this is done by calling `fetchData()` or `fetchData(force)` to force fetch it.
89+
90+
Examples:
91+
92+
```
93+
// Get a collab by its id.
94+
Collab collab = Collab.byId(420392);
95+
96+
// Force fetch the data.
97+
boolean success = collab.fetchData(true);
98+
```
99+
75100
### Comment
76101
A comment only contains the attributes from `RantContent`.
77102

0 commit comments

Comments
 (0)