UserVoiceSdk.Api.CommentsApi

Method	HTTP request	Description
ApproveById	PUT /admin/comments/{id}/approve
Create	POST /admin/comments	# Create a comment
DeleteById	DELETE /admin/comments/{id}	# Delete a comment
Get	GET /admin/comments	# List comments
GetById	GET /admin/comments/{id}	# Retrieve comments by id
SpamById	PUT /admin/comments/{id}/spam
UnremoveById	PUT /admin/comments/{id}/unremove

ApproveById

CommentResponse ApproveById (long? id, List includes = null)

Example

using System;
using System.Diagnostics;
using UserVoiceSdk.Api;
using UserVoiceSdk.Client;
using UserVoiceSdk.Models;

namespace Example
{
    public class ApproveByIdExample
    {
        private string ApiKey = "some_key";
        private string ApiSecret = "some_secret";
        private string Subdomain = "sub";
        private string Domain = "uservoice.com";

		// Credentials for authenticating as a user
		private string Username = "some.user@uservoice.com";
		private string Password = "Somepassword1234!";

        public void main()
        {
            var client = new ApiClient(subdomain: Subdomain,
									   clientId: ApiKey,
									   domain: Domain,
									   clientSecret: ApiSecret);

			// Authentication takes place on request when a token is not available
			// However, you can explicitly login using the functions below
			//client.Login(ApiKey, ApiSecret);
			//client.LoginAsUser(ApiKey, Username, Password);

            var id = 789;  // long? | 
            var includes = new List<string>(); // List<string> |  (optional) 

            try
            {
                // 
                CommentResponse result = client.Comments.ApproveById(id, includes);
                Debug.WriteLine(result);
            }
            catch (RateLimitException rle)
            {
                Debug.Print(string.Format("Rate limit exceeded. Limit: {0}, Remaining: {1}, Reset: {2}", client.RateLimiting.Limit, client.RateLimiting.Remaining, client.RateLimiting.Reset));
                Debug.Print(string.Format("Reset in {0} seconds. Reset at {1} UTC", client.RateLimiting.ResetIn(), client.RateLimiting.ResetAt()));
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling CommentsApi.ApproveById: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
id	long?
includes	List		[optional]

Return type

CommentResponse

Authorization

oauth2_password, oauth2_client_credentials

HTTP request headers

Content-Type: application/x-www-form-urlencoded
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Create

CommentResponse Create (string body, long? linksSuggestion, string bodyMimeType = null, List includes = null)

Create a comment

Example

using System;
using System.Diagnostics;
using UserVoiceSdk.Api;
using UserVoiceSdk.Client;
using UserVoiceSdk.Models;

namespace Example
{
    public class CreateExample
    {
        private string ApiKey = "some_key";
        private string ApiSecret = "some_secret";
        private string Subdomain = "sub";
        private string Domain = "uservoice.com";

		// Credentials for authenticating as a user
		private string Username = "some.user@uservoice.com";
		private string Password = "Somepassword1234!";

        public void main()
        {
            var client = new ApiClient(subdomain: Subdomain,
									   clientId: ApiKey,
									   domain: Domain,
									   clientSecret: ApiSecret);

			// Authentication takes place on request when a token is not available
			// However, you can explicitly login using the functions below
			//client.Login(ApiKey, ApiSecret);
			//client.LoginAsUser(ApiKey, Username, Password);

            var body = body_example;  // string | 
            var linksSuggestion = 789;  // long? | 
            var bodyMimeType = bodyMimeType_example;  // string |  (optional)  (default to text/plain)
            var includes = new List<string>(); // List<string> |  (optional) 

            try
            {
                // # Create a comment
                CommentResponse result = client.Comments.Create(body, linksSuggestion, bodyMimeType, includes);
                Debug.WriteLine(result);
            }
            catch (RateLimitException rle)
            {
                Debug.Print(string.Format("Rate limit exceeded. Limit: {0}, Remaining: {1}, Reset: {2}", client.RateLimiting.Limit, client.RateLimiting.Remaining, client.RateLimiting.Reset));
                Debug.Print(string.Format("Reset in {0} seconds. Reset at {1} UTC", client.RateLimiting.ResetIn(), client.RateLimiting.ResetAt()));
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling CommentsApi.Create: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Notes
body	string
linksSuggestion	long?
bodyMimeType	string	[optional] [default to text/plain]
includes	List	[optional]

Return type

CommentResponse

Authorization

oauth2_password, oauth2_client_credentials

HTTP request headers

Content-Type: application/x-www-form-urlencoded
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteById

CommentResponse DeleteById (long? id, List includes = null)

Delete a comment

Example

using System;
using System.Diagnostics;
using UserVoiceSdk.Api;
using UserVoiceSdk.Client;
using UserVoiceSdk.Models;

namespace Example
{
    public class DeleteByIdExample
    {
        private string ApiKey = "some_key";
        private string ApiSecret = "some_secret";
        private string Subdomain = "sub";
        private string Domain = "uservoice.com";

		// Credentials for authenticating as a user
		private string Username = "some.user@uservoice.com";
		private string Password = "Somepassword1234!";

        public void main()
        {
            var client = new ApiClient(subdomain: Subdomain,
									   clientId: ApiKey,
									   domain: Domain,
									   clientSecret: ApiSecret);

			// Authentication takes place on request when a token is not available
			// However, you can explicitly login using the functions below
			//client.Login(ApiKey, ApiSecret);
			//client.LoginAsUser(ApiKey, Username, Password);

            var id = 789;  // long? | 
            var includes = new List<string>(); // List<string> |  (optional) 

            try
            {
                // # Delete a comment
                CommentResponse result = client.Comments.DeleteById(id, includes);
                Debug.WriteLine(result);
            }
            catch (RateLimitException rle)
            {
                Debug.Print(string.Format("Rate limit exceeded. Limit: {0}, Remaining: {1}, Reset: {2}", client.RateLimiting.Limit, client.RateLimiting.Remaining, client.RateLimiting.Reset));
                Debug.Print(string.Format("Reset in {0} seconds. Reset at {1} UTC", client.RateLimiting.ResetIn(), client.RateLimiting.ResetAt()));
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling CommentsApi.DeleteById: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
id	long?
includes	List		[optional]

Return type

CommentResponse

Authorization

oauth2_password, oauth2_client_credentials

HTTP request headers

Content-Type: application/x-www-form-urlencoded
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Get

CommentResponsePaginated Get (long? page = null, long? perPage = null, string sort = null, List state = null, List includes = null)

List comments

Example

using System;
using System.Diagnostics;
using UserVoiceSdk.Api;
using UserVoiceSdk.Client;
using UserVoiceSdk.Models;

namespace Example
{
    public class GetExample
    {
        private string ApiKey = "some_key";
        private string ApiSecret = "some_secret";
        private string Subdomain = "sub";
        private string Domain = "uservoice.com";

		// Credentials for authenticating as a user
		private string Username = "some.user@uservoice.com";
		private string Password = "Somepassword1234!";

        public void main()
        {
            var client = new ApiClient(subdomain: Subdomain,
									   clientId: ApiKey,
									   domain: Domain,
									   clientSecret: ApiSecret);

			// Authentication takes place on request when a token is not available
			// However, you can explicitly login using the functions below
			//client.Login(ApiKey, ApiSecret);
			//client.LoginAsUser(ApiKey, Username, Password);

            var page = 789;  // long? |  (optional)  (default to 1)
            var perPage = 789;  // long? |  (optional)  (default to 20)
            var sort = sort_example;  // string |  (optional)  (default to -id)
            var state = new List<string>(); // List<string> |  (optional) 
            var includes = new List<string>(); // List<string> |  (optional) 

            try
            {
                // # List comments
                CommentResponsePaginated result = client.Comments.Get(page, perPage, sort, state, includes);
                Debug.WriteLine(result);
            }
            catch (RateLimitException rle)
            {
                Debug.Print(string.Format("Rate limit exceeded. Limit: {0}, Remaining: {1}, Reset: {2}", client.RateLimiting.Limit, client.RateLimiting.Remaining, client.RateLimiting.Reset));
                Debug.Print(string.Format("Reset in {0} seconds. Reset at {1} UTC", client.RateLimiting.ResetIn(), client.RateLimiting.ResetAt()));
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling CommentsApi.Get: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Notes
page	long?	[optional] [default to 1]
perPage	long?	[optional] [default to 20]
sort	string	[optional] [default to -id]
state	List	[optional]
includes	List	[optional]

Return type

CommentResponsePaginated

Authorization

oauth2_password, oauth2_client_credentials

HTTP request headers

Content-Type: application/x-www-form-urlencoded
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetById

CommentResponse GetById (List<int?> id, List includes = null)

Retrieve comments by id

Example

using System;
using System.Diagnostics;
using UserVoiceSdk.Api;
using UserVoiceSdk.Client;
using UserVoiceSdk.Models;

namespace Example
{
    public class GetByIdExample
    {
        private string ApiKey = "some_key";
        private string ApiSecret = "some_secret";
        private string Subdomain = "sub";
        private string Domain = "uservoice.com";

		// Credentials for authenticating as a user
		private string Username = "some.user@uservoice.com";
		private string Password = "Somepassword1234!";

        public void main()
        {
            var client = new ApiClient(subdomain: Subdomain,
									   clientId: ApiKey,
									   domain: Domain,
									   clientSecret: ApiSecret);

			// Authentication takes place on request when a token is not available
			// However, you can explicitly login using the functions below
			//client.Login(ApiKey, ApiSecret);
			//client.LoginAsUser(ApiKey, Username, Password);

            var id = new List<int?>(); // List<int?> | 
            var includes = new List<string>(); // List<string> |  (optional) 

            try
            {
                // # Retrieve comments by id
                CommentResponse result = client.Comments.GetById(id, includes);
                Debug.WriteLine(result);
            }
            catch (RateLimitException rle)
            {
                Debug.Print(string.Format("Rate limit exceeded. Limit: {0}, Remaining: {1}, Reset: {2}", client.RateLimiting.Limit, client.RateLimiting.Remaining, client.RateLimiting.Reset));
                Debug.Print(string.Format("Reset in {0} seconds. Reset at {1} UTC", client.RateLimiting.ResetIn(), client.RateLimiting.ResetAt()));
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling CommentsApi.GetById: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
id	List<int?>
includes	List		[optional]

Return type

CommentResponse

Authorization

oauth2_password, oauth2_client_credentials

HTTP request headers

Content-Type: application/x-www-form-urlencoded
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

SpamById

CommentResponse SpamById (long? id, List includes = null)

Example

using System;
using System.Diagnostics;
using UserVoiceSdk.Api;
using UserVoiceSdk.Client;
using UserVoiceSdk.Models;

namespace Example
{
    public class SpamByIdExample
    {
        private string ApiKey = "some_key";
        private string ApiSecret = "some_secret";
        private string Subdomain = "sub";
        private string Domain = "uservoice.com";

		// Credentials for authenticating as a user
		private string Username = "some.user@uservoice.com";
		private string Password = "Somepassword1234!";

        public void main()
        {
            var client = new ApiClient(subdomain: Subdomain,
									   clientId: ApiKey,
									   domain: Domain,
									   clientSecret: ApiSecret);

			// Authentication takes place on request when a token is not available
			// However, you can explicitly login using the functions below
			//client.Login(ApiKey, ApiSecret);
			//client.LoginAsUser(ApiKey, Username, Password);

            var id = 789;  // long? | 
            var includes = new List<string>(); // List<string> |  (optional) 

            try
            {
                // 
                CommentResponse result = client.Comments.SpamById(id, includes);
                Debug.WriteLine(result);
            }
            catch (RateLimitException rle)
            {
                Debug.Print(string.Format("Rate limit exceeded. Limit: {0}, Remaining: {1}, Reset: {2}", client.RateLimiting.Limit, client.RateLimiting.Remaining, client.RateLimiting.Reset));
                Debug.Print(string.Format("Reset in {0} seconds. Reset at {1} UTC", client.RateLimiting.ResetIn(), client.RateLimiting.ResetAt()));
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling CommentsApi.SpamById: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
id	long?
includes	List		[optional]

Return type

CommentResponse

Authorization

oauth2_password, oauth2_client_credentials

HTTP request headers

Content-Type: application/x-www-form-urlencoded
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UnremoveById

CommentResponse UnremoveById (long? id, List includes = null)

Example

using System;
using System.Diagnostics;
using UserVoiceSdk.Api;
using UserVoiceSdk.Client;
using UserVoiceSdk.Models;

namespace Example
{
    public class UnremoveByIdExample
    {
        private string ApiKey = "some_key";
        private string ApiSecret = "some_secret";
        private string Subdomain = "sub";
        private string Domain = "uservoice.com";

		// Credentials for authenticating as a user
		private string Username = "some.user@uservoice.com";
		private string Password = "Somepassword1234!";

        public void main()
        {
            var client = new ApiClient(subdomain: Subdomain,
									   clientId: ApiKey,
									   domain: Domain,
									   clientSecret: ApiSecret);

			// Authentication takes place on request when a token is not available
			// However, you can explicitly login using the functions below
			//client.Login(ApiKey, ApiSecret);
			//client.LoginAsUser(ApiKey, Username, Password);

            var id = 789;  // long? | 
            var includes = new List<string>(); // List<string> |  (optional) 

            try
            {
                // 
                CommentResponse result = client.Comments.UnremoveById(id, includes);
                Debug.WriteLine(result);
            }
            catch (RateLimitException rle)
            {
                Debug.Print(string.Format("Rate limit exceeded. Limit: {0}, Remaining: {1}, Reset: {2}", client.RateLimiting.Limit, client.RateLimiting.Remaining, client.RateLimiting.Reset));
                Debug.Print(string.Format("Reset in {0} seconds. Reset at {1} UTC", client.RateLimiting.ResetIn(), client.RateLimiting.ResetAt()));
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling CommentsApi.UnremoveById: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
id	long?
includes	List		[optional]

Return type

CommentResponse

Authorization

oauth2_password, oauth2_client_credentials

HTTP request headers

Content-Type: application/x-www-form-urlencoded
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

CommentsApi.md

Latest commit

History

CommentsApi.md

File metadata and controls

UserVoiceSdk.Api.CommentsApi

ApproveById

Example

Parameters

Return type

Authorization

HTTP request headers

Create

Create a comment

Example

Parameters

Return type

Authorization

HTTP request headers

DeleteById

Delete a comment

Example

Parameters

Return type

Authorization

HTTP request headers

Get

List comments

Example

Parameters

Return type

Authorization

HTTP request headers

GetById

Retrieve comments by id

Example

Parameters

Return type

Authorization

HTTP request headers

SpamById

Example

Parameters

Return type

Authorization

HTTP request headers

UnremoveById

Example

Parameters

Return type

Authorization

HTTP request headers