Reddit.NET  1.5
Reddit.NET is a .NET Standard library that provides easy access to the Reddit API with virtually no boilerplate code required.
Reddit.Models.Wiki Class Reference
Inheritance diagram for Reddit.Models.Wiki:
Reddit.Models.BaseModel Reddit.Models.Internal.Request

Public Member Functions

 Wiki (string appId, string appSecret, string refreshToken, string accessToken, ref RestClient restClient, string deviceId=null, string userAgent=null)
 
void AllowEditor (WikiPageEditorInput wikiPageEditorInput, string subreddit=null)
 Allow username to edit this wiki page. More...
 
async Task AllowEditorAsync (WikiPageEditorInput wikiPageEditorInput, string subreddit=null)
 Asynchronously allow username to edit this wiki page. More...
 
void DenyEditor (WikiPageEditorInput wikiPageEditorInput, string subreddit=null)
 Deny username to edit this wiki page. More...
 
async Task DenyEditorAsync (WikiPageEditorInput wikiPageEditorInput, string subreddit=null)
 Asynchronously deny username to edit this wiki page. More...
 
void Edit (WikiEditPageInput wikiEditPageInput, string subreddit=null)
 Edit a wiki page. More...
 
async Task EditAsync (WikiEditPageInput wikiEditPageInput, string subreddit=null)
 Edit a wiki page asynchronously. More...
 
void Create (WikiCreatePageInput wikiCreatePageInput, string subreddit=null)
 Create a wiki page. More...
 
async Task CreateAsync (WikiCreatePageInput wikiCreatePageInput, string subreddit=null)
 Create a wiki page asynchronously. More...
 
StatusResult Hide (WikiPageRevisionInput wikiPageRevisionInput, string subreddit=null)
 Toggle the public visibility of a wiki page revision. More...
 
async Task< StatusResultHideAsync (WikiPageRevisionInput wikiPageRevisionInput, string subreddit=null)
 Toggle the public visibility of a wiki page revision asynchronously. More...
 
void Revert (WikiPageRevisionInput wikiPageRevisionInput, string subreddit=null)
 Revert a wiki page to revision. More...
 
async Task RevertAsync (WikiPageRevisionInput wikiPageRevisionInput, string subreddit=null)
 Revert a wiki page to revision asynchronously. More...
 
object Discussions (string page, SrListingInput srListingInput, string subreddit=null)
 Retrieve a list of discussions about this wiki page. This endpoint is a listing. More...
 
WikiPageListing Pages (string subreddit=null)
 Retrieve a list of wiki pages in this subreddit. More...
 
WikiPageRevisionContainer Revisions (SrListingInput srListingInput, string subreddit=null)
 Retrieve a list of recently changed wiki pages in this subreddit. More...
 
WikiPageRevisionContainer PageRevisions (string page, SrListingInput srListingInput, string subreddit=null)
 Retrieve a list of revisions of this wiki page. This endpoint is a listing. More...
 
WikiPageSettingsContainer GetPermissions (string page, string subreddit=null)
 Retrieve the current permission settings for page. More...
 
WikiPageSettingsContainer UpdatePermissions (string page, WikiUpdatePermissionsInput wikiUpdatePermissionsInput, string subreddit=null)
 Update the permissions and visibility of wiki page. More...
 
async Task< WikiPageSettingsContainerUpdatePermissionsAsync (string page, WikiUpdatePermissionsInput wikiUpdatePermissionsInput, string subreddit=null)
 Update the permissions and visibility of wiki page asynchronously. More...
 
WikiPageSettingsContainer UpdatePermissions (string page, WikiPageSettings wikiPageSettings, string subreddit=null)
 Update the permissions and visibility of wiki page. More...
 
async Task< WikiPageSettingsContainerUpdatePermissionsAsync (string page, WikiPageSettings wikiPageSettings, string subreddit=null)
 Update the permissions and visibility of wiki page asynchronously. More...
 
WikiPageContainer Page (string page, WikiPageContentInput wikiPageContentInput, string subreddit=null)
 Return the content of a wiki page. If v is given, show the wiki page as it was at that version. If both v and v2 are given, show a diff of the two. More...
 
- Public Member Functions inherited from Reddit.Models.BaseModel
 BaseModel (string appId, string appSecret, string refreshToken, string accessToken, ref RestClient restClient, string deviceId=null, string userAgent=null)
 
string Sr (string subreddit)
 
- Public Member Functions inherited from Reddit.Models.Internal.Request
 Request (string appId, string appSecret, string refreshToken, string accessToken, ref RestClient restClient, string deviceId=null, string userAgent=null)
 
SendRequest< T > (string url, dynamic parameters, Method method=Method.GET, string contentType="application/x-www-form-urlencoded")
 
async Task< T > SendRequestAsync< T > (string url, dynamic parameters, Method method=Method.GET, string contentType="application/x-www-form-urlencoded")
 
RestRequest PrepareIDRequest (string path, string id, Method method=Method.POST)
 
RestRequest PrepareJSONRequest (string path, Method method=Method.POST)
 
RestRequest PrepareRequest (string url, Method method=Method.GET, string contentType="application/x-www-form-urlencoded")
 
RestRequest PrepareRequest (string url, Method method, List< Parameter > parameters, List< FileParameter > files, string contentType="application/x-www-form-urlencoded")
 
RestRequest PrepareRequest (RestRequest restRequest, string contentType="application/x-www-form-urlencoded")
 
string GetVersion ()
 
string ExecuteRequest (string url, Method method=Method.GET)
 
async Task< string > ExecuteRequestAsync (string url, Method method=Method.GET)
 
string ExecuteRequest (RestRequest restRequest)
 
async Task< string > ExecuteRequestAsync (RestRequest restRequest)
 
void UpdateAccessToken (string accessToken)
 
void UpdateRequests (List< DateTime > requests)
 
void AddParamIfNotNull (string name, dynamic value, ref RestRequest restRequest)
 

Additional Inherited Members

- Protected Member Functions inherited from Reddit.Models.Internal.Request
virtual void OnTokenUpdated (TokenUpdateEventArgs e)
 
virtual void OnRequestsUpdated (RequestsUpdateEventArgs e)
 
- Events inherited from Reddit.Models.Internal.Request
EventHandler< TokenUpdateEventArgsTokenUpdated
 
EventHandler< RequestsUpdateEventArgsRequestsUpdated
 

Constructor & Destructor Documentation

◆ Wiki()

Reddit.Models.Wiki.Wiki ( string  appId,
string  appSecret,
string  refreshToken,
string  accessToken,
ref RestClient  restClient,
string  deviceId = null,
string  userAgent = null 
)

Member Function Documentation

◆ AllowEditor()

void Reddit.Models.Wiki.AllowEditor ( WikiPageEditorInput  wikiPageEditorInput,
string  subreddit = null 
)

Allow username to edit this wiki page.

Parameters
wikiPageEditorInputA valid WikiPageEditorInput instance
subredditThe subreddit where the wiki lives

◆ AllowEditorAsync()

async Task Reddit.Models.Wiki.AllowEditorAsync ( WikiPageEditorInput  wikiPageEditorInput,
string  subreddit = null 
)

Asynchronously allow username to edit this wiki page.

Parameters
wikiPageEditorInputA valid WikiPageEditorInput instance
subredditThe subreddit where the wiki lives

◆ Create()

void Reddit.Models.Wiki.Create ( WikiCreatePageInput  wikiCreatePageInput,
string  subreddit = null 
)

Create a wiki page.

Parameters
wikiCreatePageInputA valid WikiCreatePageInput instance
subredditThe subreddit where the wiki lives

◆ CreateAsync()

async Task Reddit.Models.Wiki.CreateAsync ( WikiCreatePageInput  wikiCreatePageInput,
string  subreddit = null 
)

Create a wiki page asynchronously.

Parameters
wikiCreatePageInputA valid WikiCreatePageInput instance
subredditThe subreddit where the wiki lives

◆ DenyEditor()

void Reddit.Models.Wiki.DenyEditor ( WikiPageEditorInput  wikiPageEditorInput,
string  subreddit = null 
)

Deny username to edit this wiki page.

Parameters
wikiPageEditorInputA valid WikiPageEditorInput instance
subredditThe subreddit where the wiki lives

◆ DenyEditorAsync()

async Task Reddit.Models.Wiki.DenyEditorAsync ( WikiPageEditorInput  wikiPageEditorInput,
string  subreddit = null 
)

Asynchronously deny username to edit this wiki page.

Parameters
wikiPageEditorInputA valid WikiPageEditorInput instance
subredditThe subreddit where the wiki lives

◆ Discussions()

object Reddit.Models.Wiki.Discussions ( string  page,
SrListingInput  srListingInput,
string  subreddit = null 
)

Retrieve a list of discussions about this wiki page. This endpoint is a listing.

Parameters
pagethe name of an existing wiki page
srListingInputA valid SrListingInput instance
subredditThe subreddit where the wiki lives
Returns
(TODO - Untested)

◆ Edit()

void Reddit.Models.Wiki.Edit ( WikiEditPageInput  wikiEditPageInput,
string  subreddit = null 
)

Edit a wiki page.

Parameters
wikiEditPageInputA valid WikiEditPageInput instance
subredditThe subreddit where the wiki lives

◆ EditAsync()

async Task Reddit.Models.Wiki.EditAsync ( WikiEditPageInput  wikiEditPageInput,
string  subreddit = null 
)

Edit a wiki page asynchronously.

Parameters
wikiEditPageInputA valid WikiEditPageInput instance
subredditThe subreddit where the wiki lives

◆ GetPermissions()

WikiPageSettingsContainer Reddit.Models.Wiki.GetPermissions ( string  page,
string  subreddit = null 
)

Retrieve the current permission settings for page.

Parameters
pagethe name of an existing wiki page
subredditThe subreddit where the wiki lives
Returns
An object containing wiki page settings.

◆ Hide()

StatusResult Reddit.Models.Wiki.Hide ( WikiPageRevisionInput  wikiPageRevisionInput,
string  subreddit = null 
)

Toggle the public visibility of a wiki page revision.

Parameters
wikiPageRevisionInputA valid WikiPageRevisionInput instance
subredditThe subreddit where the wiki lives
Returns
Status object indicating true if page was hidden, false if page was unhidden.

◆ HideAsync()

async Task<StatusResult> Reddit.Models.Wiki.HideAsync ( WikiPageRevisionInput  wikiPageRevisionInput,
string  subreddit = null 
)

Toggle the public visibility of a wiki page revision asynchronously.

Parameters
wikiPageRevisionInputA valid WikiPageRevisionInput instance
subredditThe subreddit where the wiki lives
Returns
Status object indicating true if page was hidden, false if page was unhidden.

◆ Page()

WikiPageContainer Reddit.Models.Wiki.Page ( string  page,
WikiPageContentInput  wikiPageContentInput,
string  subreddit = null 
)

Return the content of a wiki page. If v is given, show the wiki page as it was at that version. If both v and v2 are given, show a diff of the two.

Parameters
pagethe name of an existing wiki page
wikiPageContentInputA valid WikiPageContentInput instance
subredditThe subreddit where the wiki lives
Returns
An object containing wiki page data.

◆ PageRevisions()

WikiPageRevisionContainer Reddit.Models.Wiki.PageRevisions ( string  page,
SrListingInput  srListingInput,
string  subreddit = null 
)

Retrieve a list of revisions of this wiki page. This endpoint is a listing.

Parameters
pagethe name of an existing wiki page
srListingInputA valid SrListingInput instance
subredditThe subreddit where the wiki lives
Returns
A list of revisions.

◆ Pages()

WikiPageListing Reddit.Models.Wiki.Pages ( string  subreddit = null)

Retrieve a list of wiki pages in this subreddit.

Parameters
subredditThe subreddit where the wiki lives
Returns
A list of wiki pages.

◆ Revert()

void Reddit.Models.Wiki.Revert ( WikiPageRevisionInput  wikiPageRevisionInput,
string  subreddit = null 
)

Revert a wiki page to revision.

Parameters
wikiPageRevisionInputA valid WikiPageRevisionInput instance
subredditThe subreddit where the wiki lives

◆ RevertAsync()

async Task Reddit.Models.Wiki.RevertAsync ( WikiPageRevisionInput  wikiPageRevisionInput,
string  subreddit = null 
)

Revert a wiki page to revision asynchronously.

Parameters
wikiPageRevisionInputA valid WikiPageRevisionInput instance
subredditThe subreddit where the wiki lives

◆ Revisions()

WikiPageRevisionContainer Reddit.Models.Wiki.Revisions ( SrListingInput  srListingInput,
string  subreddit = null 
)

Retrieve a list of recently changed wiki pages in this subreddit.

Parameters
srListingInputA valid SrListingInput instance
subredditThe subreddit where the wiki lives
Returns
A list of wiki pages.

◆ UpdatePermissions() [1/2]

WikiPageSettingsContainer Reddit.Models.Wiki.UpdatePermissions ( string  page,
WikiPageSettings  wikiPageSettings,
string  subreddit = null 
)

Update the permissions and visibility of wiki page.

Parameters
pagethe name of an existing wiki page
wikiPageSettingsA valid instance of WikiPageSettings
subredditThe subreddit where the wiki lives
Returns
An object containing wiki page settings.

◆ UpdatePermissions() [2/2]

WikiPageSettingsContainer Reddit.Models.Wiki.UpdatePermissions ( string  page,
WikiUpdatePermissionsInput  wikiUpdatePermissionsInput,
string  subreddit = null 
)

Update the permissions and visibility of wiki page.

Parameters
pagethe name of an existing wiki page
wikiUpdatePermissionsInputA valid WikiUpdatePermissionsInput instance
subredditThe subreddit where the wiki lives
Returns
An object containing wiki page settings.

◆ UpdatePermissionsAsync() [1/2]

async Task<WikiPageSettingsContainer> Reddit.Models.Wiki.UpdatePermissionsAsync ( string  page,
WikiPageSettings  wikiPageSettings,
string  subreddit = null 
)

Update the permissions and visibility of wiki page asynchronously.

Parameters
pagethe name of an existing wiki page
wikiPageSettingsA valid instance of WikiPageSettings
subredditThe subreddit where the wiki lives
Returns
An object containing wiki page settings.

◆ UpdatePermissionsAsync() [2/2]

async Task<WikiPageSettingsContainer> Reddit.Models.Wiki.UpdatePermissionsAsync ( string  page,
WikiUpdatePermissionsInput  wikiUpdatePermissionsInput,
string  subreddit = null 
)

Update the permissions and visibility of wiki page asynchronously.

Parameters
pagethe name of an existing wiki page
wikiUpdatePermissionsInputA valid WikiUpdatePermissionsInput instance
subredditThe subreddit where the wiki lives
Returns
An object containing wiki page settings.

The documentation for this class was generated from the following file: