Skip to content

Latest commit

 

History

History
682 lines (522 loc) · 18.9 KB

CommentsApi.md

File metadata and controls

682 lines (522 loc) · 18.9 KB

CommentsApi

All URIs are relative to https://api.frame.io

Method HTTP request Description
completeComment POST /v2/comments/{comment_id}/complete Mark completed
createComment POST /v2/assets/{asset_id}/comments Create a Comment
createCommentImpressionLike POST /v2/comments/{comment_id}/like Create a Like on a Comment
createReply POST /v2/comments/{comment_id}/replies Leave a Reply on a Comment
deleteComment DELETE /v2/comments/{comment_id} Delete a Comment
deleteCommentImpressionLike DELETE /v2/comments/{comment_id}/like Delete a like from a comment
getComment GET /v2/comments/{comment_id} Get a Comment by ID
getCommentImpressions GET /v2/comments/{comment_id}/impressions Get impressions
getComments GET /v2/assets/{asset_id}/comments Get all the Comments and Replies from a Comment thread
getReplies GET /v2/comments/{comment_id}/replies Get comments and replies
uncompleteComment DELETE /v2/comments/{comment_id}/complete Mark a Comment as Uncompleted
updateComment PUT /v2/comments/{comment_id} Update a Comment

completeComment

Comment completeComment(commentId)

Mark completed

Complete a "Task" on a given Comment

Example

// Import classes:
//import dev.androidbroadcast.framesdk.infrastructure.*
//import dev.androidbroadcast.framesdk.models.*

val apiInstance = CommentsApi()
val commentId : kotlin.String = eefb57e0-79f2-4bc7-9b70-99fbc175175c // kotlin.String | Comment ID
try {
    val result : Comment = apiInstance.completeComment(commentId)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling CommentsApi#completeComment")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling CommentsApi#completeComment")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
commentId kotlin.String Comment ID

Return type

Comment

Authorization

Configure OAuth2: ApiClient.accessToken = "" Configure OAuth2: ApiClient.accessToken = "" Configure JWT: ApiClient.accessToken = "" Configure DeveloperToken: ApiClient.accessToken = ""

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

createComment

Comment createComment(assetId, createCommentRequest)

Create a Comment

Leave a Comment on an Asset

Example

// Import classes:
//import dev.androidbroadcast.framesdk.infrastructure.*
//import dev.androidbroadcast.framesdk.models.*

val apiInstance = CommentsApi()
val assetId : kotlin.String = 38400000-8cf0-11bd-b23e-10b96e4ef00d // kotlin.String | 
val createCommentRequest : CreateCommentRequest =  // CreateCommentRequest | Comment to create or update
try {
    val result : Comment = apiInstance.createComment(assetId, createCommentRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling CommentsApi#createComment")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling CommentsApi#createComment")
    e.printStackTrace()
}

Parameters

| assetId | kotlin.String| | |

Name Type Description Notes
createCommentRequest CreateCommentRequest Comment to create or update [optional]

Return type

Comment

Authorization

Configure OAuth2: ApiClient.accessToken = "" Configure OAuth2: ApiClient.accessToken = "" Configure JWT: ApiClient.accessToken = "" Configure DeveloperToken: ApiClient.accessToken = ""

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

createCommentImpressionLike

kotlin.collections.List<CommentImpression> createCommentImpressionLike(commentId)

Create a Like on a Comment

Leave a thumbs-up on a Comment

Example

// Import classes:
//import dev.androidbroadcast.framesdk.infrastructure.*
//import dev.androidbroadcast.framesdk.models.*

val apiInstance = CommentsApi()
val commentId : kotlin.String = 38400000-8cf0-11bd-b23e-10b96e4ef00d // kotlin.String | 
try {
    val result : kotlin.collections.List<CommentImpression> = apiInstance.createCommentImpressionLike(commentId)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling CommentsApi#createCommentImpressionLike")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling CommentsApi#createCommentImpressionLike")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
commentId kotlin.String

Return type

kotlin.collections.List<CommentImpression>

Authorization

Configure OAuth2: ApiClient.accessToken = "" Configure OAuth2: ApiClient.accessToken = "" Configure JWT: ApiClient.accessToken = "" Configure DeveloperToken: ApiClient.accessToken = ""

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

createReply

Comment createReply(commentId, createCommentRequest)

Leave a Reply on a Comment

Leave a Reply on a given Comment

Example

// Import classes:
//import dev.androidbroadcast.framesdk.infrastructure.*
//import dev.androidbroadcast.framesdk.models.*

val apiInstance = CommentsApi()
val commentId : kotlin.String = eefb57e0-79f2-4bc7-9b70-99fbc175175c // kotlin.String | Comment ID
val createCommentRequest : CreateCommentRequest =  // CreateCommentRequest | Comment to create or update
try {
    val result : Comment = apiInstance.createReply(commentId, createCommentRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling CommentsApi#createReply")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling CommentsApi#createReply")
    e.printStackTrace()
}

Parameters

| commentId | kotlin.String| Comment ID | |

Name Type Description Notes
createCommentRequest CreateCommentRequest Comment to create or update [optional]

Return type

Comment

Authorization

Configure OAuth2: ApiClient.accessToken = "" Configure OAuth2: ApiClient.accessToken = "" Configure JWT: ApiClient.accessToken = "" Configure DeveloperToken: ApiClient.accessToken = ""

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

deleteComment

Comment deleteComment(commentId)

Delete a Comment

Delete a Comment or Reply using its ID

Example

// Import classes:
//import dev.androidbroadcast.framesdk.infrastructure.*
//import dev.androidbroadcast.framesdk.models.*

val apiInstance = CommentsApi()
val commentId : kotlin.String = eefb57e0-79f2-4bc7-9b70-99fbc175175c // kotlin.String | Comment ID
try {
    val result : Comment = apiInstance.deleteComment(commentId)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling CommentsApi#deleteComment")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling CommentsApi#deleteComment")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
commentId kotlin.String Comment ID

Return type

Comment

Authorization

Configure OAuth2: ApiClient.accessToken = "" Configure OAuth2: ApiClient.accessToken = "" Configure JWT: ApiClient.accessToken = "" Configure DeveloperToken: ApiClient.accessToken = ""

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

deleteCommentImpressionLike

kotlin.collections.List<CommentImpression> deleteCommentImpressionLike(commentId)

Delete a like from a comment

Remove a Like from a Comment

Example

// Import classes:
//import dev.androidbroadcast.framesdk.infrastructure.*
//import dev.androidbroadcast.framesdk.models.*

val apiInstance = CommentsApi()
val commentId : kotlin.String = 38400000-8cf0-11bd-b23e-10b96e4ef00d // kotlin.String | 
try {
    val result : kotlin.collections.List<CommentImpression> = apiInstance.deleteCommentImpressionLike(commentId)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling CommentsApi#deleteCommentImpressionLike")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling CommentsApi#deleteCommentImpressionLike")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
commentId kotlin.String

Return type

kotlin.collections.List<CommentImpression>

Authorization

Configure OAuth2: ApiClient.accessToken = "" Configure OAuth2: ApiClient.accessToken = "" Configure JWT: ApiClient.accessToken = "" Configure DeveloperToken: ApiClient.accessToken = ""

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

getComment

Comment getComment(commentId, include)

Get a Comment by ID

Fetch a Comment by its ID

Example

// Import classes:
//import dev.androidbroadcast.framesdk.infrastructure.*
//import dev.androidbroadcast.framesdk.models.*

val apiInstance = CommentsApi()
val commentId : kotlin.String = eefb57e0-79f2-4bc7-9b70-99fbc175175c // kotlin.String | Comment ID
val include : kotlin.String = include_example // kotlin.String | 
try {
    val result : Comment = apiInstance.getComment(commentId, include)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling CommentsApi#getComment")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling CommentsApi#getComment")
    e.printStackTrace()
}

Parameters

| commentId | kotlin.String| Comment ID | |

Name Type Description Notes
include kotlin.String [optional]

Return type

Comment

Authorization

Configure OAuth2: ApiClient.accessToken = "" Configure OAuth2: ApiClient.accessToken = "" Configure JWT: ApiClient.accessToken = "" Configure DeveloperToken: ApiClient.accessToken = ""

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

getCommentImpressions

kotlin.collections.List<CommentImpression> getCommentImpressions(commentId, include)

Get impressions

Fetch a list of who has 'seen' your comment

Example

// Import classes:
//import dev.androidbroadcast.framesdk.infrastructure.*
//import dev.androidbroadcast.framesdk.models.*

val apiInstance = CommentsApi()
val commentId : kotlin.String = 38400000-8cf0-11bd-b23e-10b96e4ef00d // kotlin.String | 
val include : kotlin.String = include_example // kotlin.String | 
try {
    val result : kotlin.collections.List<CommentImpression> = apiInstance.getCommentImpressions(commentId, include)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling CommentsApi#getCommentImpressions")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling CommentsApi#getCommentImpressions")
    e.printStackTrace()
}

Parameters

| commentId | kotlin.String| | |

Name Type Description Notes
include kotlin.String [optional]

Return type

kotlin.collections.List<CommentImpression>

Authorization

Configure OAuth2: ApiClient.accessToken = "" Configure OAuth2: ApiClient.accessToken = "" Configure JWT: ApiClient.accessToken = "" Configure DeveloperToken: ApiClient.accessToken = ""

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

getComments

kotlin.collections.List<Comment> getComments(assetId, include)

Get all the Comments and Replies from a Comment thread

This endpoint will return all comments and replies in a flat list.

Example

// Import classes:
//import dev.androidbroadcast.framesdk.infrastructure.*
//import dev.androidbroadcast.framesdk.models.*

val apiInstance = CommentsApi()
val assetId : kotlin.String = 38400000-8cf0-11bd-b23e-10b96e4ef00d // kotlin.String | 
val include : kotlin.String = include_example // kotlin.String | 
try {
    val result : kotlin.collections.List<Comment> = apiInstance.getComments(assetId, include)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling CommentsApi#getComments")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling CommentsApi#getComments")
    e.printStackTrace()
}

Parameters

| assetId | kotlin.String| | |

Name Type Description Notes
include kotlin.String [optional]

Return type

kotlin.collections.List<Comment>

Authorization

Configure OAuth2: ApiClient.accessToken = "" Configure OAuth2: ApiClient.accessToken = "" Configure JWT: ApiClient.accessToken = "" Configure DeveloperToken: ApiClient.accessToken = ""

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

getReplies

kotlin.collections.List<Comment> getReplies(commentId, include)

Get comments and replies

Fetch all Comments and Replies for a given Comment or Reply ID

Example

// Import classes:
//import dev.androidbroadcast.framesdk.infrastructure.*
//import dev.androidbroadcast.framesdk.models.*

val apiInstance = CommentsApi()
val commentId : kotlin.String = eefb57e0-79f2-4bc7-9b70-99fbc175175c // kotlin.String | Comment ID
val include : kotlin.String = include_example // kotlin.String | 
try {
    val result : kotlin.collections.List<Comment> = apiInstance.getReplies(commentId, include)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling CommentsApi#getReplies")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling CommentsApi#getReplies")
    e.printStackTrace()
}

Parameters

| commentId | kotlin.String| Comment ID | |

Name Type Description Notes
include kotlin.String [optional] [default to "replies"]

Return type

kotlin.collections.List<Comment>

Authorization

Configure OAuth2: ApiClient.accessToken = "" Configure OAuth2: ApiClient.accessToken = "" Configure JWT: ApiClient.accessToken = "" Configure DeveloperToken: ApiClient.accessToken = ""

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

uncompleteComment

Comment uncompleteComment(commentId)

Mark a Comment as Uncompleted

If a Comment has been marked Completed, you can reset its to Uncompleted by hitting this endpoint.

Example

// Import classes:
//import dev.androidbroadcast.framesdk.infrastructure.*
//import dev.androidbroadcast.framesdk.models.*

val apiInstance = CommentsApi()
val commentId : kotlin.String = eefb57e0-79f2-4bc7-9b70-99fbc175175c // kotlin.String | Comment ID
try {
    val result : Comment = apiInstance.uncompleteComment(commentId)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling CommentsApi#uncompleteComment")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling CommentsApi#uncompleteComment")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
commentId kotlin.String Comment ID

Return type

Comment

Authorization

Configure OAuth2: ApiClient.accessToken = "" Configure OAuth2: ApiClient.accessToken = "" Configure JWT: ApiClient.accessToken = "" Configure DeveloperToken: ApiClient.accessToken = ""

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

updateComment

Comment updateComment(commentId, createCommentRequest)

Update a Comment

Update a Comment via its ID, overwriting only the passed key/value pairs

Example

// Import classes:
//import dev.androidbroadcast.framesdk.infrastructure.*
//import dev.androidbroadcast.framesdk.models.*

val apiInstance = CommentsApi()
val commentId : kotlin.String = eefb57e0-79f2-4bc7-9b70-99fbc175175c // kotlin.String | Comment ID
val createCommentRequest : CreateCommentRequest =  // CreateCommentRequest | Comment to create or update
try {
    val result : Comment = apiInstance.updateComment(commentId, createCommentRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling CommentsApi#updateComment")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling CommentsApi#updateComment")
    e.printStackTrace()
}

Parameters

| commentId | kotlin.String| Comment ID | |

Name Type Description Notes
createCommentRequest CreateCommentRequest Comment to create or update [optional]

Return type

Comment

Authorization

Configure OAuth2: ApiClient.accessToken = "" Configure OAuth2: ApiClient.accessToken = "" Configure JWT: ApiClient.accessToken = "" Configure DeveloperToken: ApiClient.accessToken = ""

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json