Skip to content

Commit

Permalink
Updated docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
DamienDennehy committed Dec 26, 2015
1 parent 03545fe commit 572c4a4
Show file tree
Hide file tree
Showing 4 changed files with 43 additions and 3 deletions.
29 changes: 29 additions & 0 deletions docs/notification-endpoint.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Notification Endpoint

##GetNotificationAsync
Returns the data about a specific notification. OAuth authentication required.

var client = new ImgurClient("YOUR_CLIENT_ID", "YOUR_CLIENT_SECRET", YOUR_OAUTH2_TOKEN);
var endpoint = new ConversationEndpoint(client);
var notification = await endpoint.GetNotificationAsync("NOTIFICATION_ID");
##GetNotificationsAsync
Returns all of the notifications for the user. OAuth authentication required.

var client = new ImgurClient("YOUR_CLIENT_ID", "YOUR_CLIENT_SECRET", YOUR_OAUTH2_TOKEN);
var endpoint = new ConversationEndpoint(client);
var notifications = await endpoint.GetNotificationsAsync();

##MarkNotificationViewedAsync
Marks a notification as viewed. OAuth authentication required.

var client = new ImgurClient("YOUR_CLIENT_ID", "YOUR_CLIENT_SECRET", YOUR_OAUTH2_TOKEN);
var endpoint = new ConversationEndpoint(client);
var marked = await endpoint.MarkNotificationViewedAsync("NOTIFICATION_ID");

##MarkNotificationsViewedAsync
Marks notifications as viewed. OAuth authentication required.

var client = new ImgurClient("YOUR_CLIENT_ID", "YOUR_CLIENT_SECRET", YOUR_OAUTH2_TOKEN);
var endpoint = new ConversationEndpoint(client);
var marked = await endpoint.MarkNotificationsViewedAsync(new List<string>{"NOTIFICATION_ID", "ANOTHER_NOTIFICATION_ID"});
8 changes: 8 additions & 0 deletions docs/release-notes.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
# Release Notes

## Version 3.4.0 (2015-12-26)
* Added Custom Gallery endpoint.
* Added Conversation endpoint.
* Added Notification endpoint.
* Updated UpdateRateLimit method to prevent OverflowExceptions.
* Updated comments on all exceptions thrown.
* Moved exceptions to base namespace.

## Version 3.3.0 (2015-12-23)
* Added CommentEndpoint.
* Added AccountUsername to OAuth2Token.
Expand Down
6 changes: 3 additions & 3 deletions docs/status.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,16 +11,16 @@
* Account endpoint.
* Album endpoint.
* Comment endpoint.
* Conversation endpoint.
* Custom Gallery endpoint.
* Image endpoint.
* Notification endpoint.
* OAuth2 endpoint.
* Rate Limit endpoint.

##ToDo

###Endpoints
* Custom Gallery endpoint.
* Conversation endpoint.
* Notification endpoint.
* Memegen endpoint.
* Topic endpoint.
* Gallery endpoint.
3 changes: 3 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,10 @@ pages:
- 'Account Endpoint': 'account-endpoint.md'
- 'Album Endpoint': 'album-endpoint.md'
- 'Comment Endpoint': 'comment-endpoint.md'
- 'Conversation Endpoint': 'conversation-endpoint.md'
- 'Custom Gallery Endpoint': 'custom-gallery-endpoint.md'
- 'Image Endpoint': 'image-endpoint.md'
- 'Notification Endpoint': 'notification-endpoint.md'
- 'OAuth2 Endpoint': 'oauth2-endpoint.md'
- 'Rate Limit Endpoint': 'rate-limit-endpoint.md'
- 'Status': 'status.md'
Expand Down

0 comments on commit 572c4a4

Please sign in to comment.