Creator - GluedIn

selected title

On this page
Creator methods
Method Method detail
getSoundList() Used to get the list of available music/sounds.
getContentUploadCategories() Used to get the list of all the available categories to tag a content/video while uploading.
getContentUploadUrl() Used to get the S3 bucket URL to upload the user created content.
uploadContentMetaData( Used to upload the meta data of the created video for logged in user.
uploadContent() Used to upload/push the created video on the fetched S3 bucket URL. Refer getContentUploadUrl() to get the S3 url.
getHashtagSuggestion() Used to fetch suggested hashtags and challenges based on queried parameter.
getTagFriendList() Used to fetch the list of all users/friends while uploading the content. Refer uploadContentMetaData() to push the tagged user data on content.
  • For Fetching Music/Sound List
    API Class : CreatorInteractor
    Method : getSoundList
    Used to get the list of available music/sounds.
    Request:
    • Parameters
    • limit : How much music/sounds list you want in a single response
    • offset : It's the current page/offset
    Response:
    • Response Object : MusicList
    • Message : It is a simple string message
    • StatusCode : It returns an API status code (like 200,201,500,401)
    • Success : It returns boolean value, (true/false)
    • data : it returns a list of Music/Sounds
  • For Fetching Category List to tag video
    API Class : CreatorInteractor
    Method : getContentUploadCategories()
    Used to get the list of all the available categories to tag a content/video while uploading.
    Request:
    • Parameters
    • limit: How many categories you want in a single response
    • offset: It's the current page/offset
    Response:
    • Response Object : MusicList
    • Message: It is a simple string message
    • StatusCode : It returns an API status code (like 200,201,500,401)
    • Success: It returns boolean value, (true/false)
    • data : It returns category List
  • Fetch S3 URL to Upload Video
    API Class : CreatorInteractor
    Method : getContentUploadUrl()
    Used to get the S3 bucket URL to upload the user created content.
    Response:
    • Response Object : S3Url
    • Message: It is a simple string message
    • StatusCode : It returns an API status code (like 200,201,500,401)
    • Success: It returns boolean value, (true/false)
    • data : It returns S3 URL
  • To Upload Video MetaData
    API Class : CreatorInteractor
    Method : uploadContentMetaData()
    Used to upload the meta data of the created video for logged in user.
    Request:
    • Request Object : UploadVideoParams
    • Parameters
    • userId : Logged in User id
    • s3Url : S3 URL(fetched via getS3Url method )
    • Title : Video Title
    • thumbnailUrl : Video thumbnail Url
    • description : video description
    • follow : true
    • Type : video type
    • Visibility: PUBLIC
    • categoryId : category Id
    • categoryName : category name
    • taggedUsers : Tagged user list
    • contentUrl : MutableList < ContentUrlPram > (no of url)
    • contentType : if multi content then “multi” else can be empty
    • metaKeys : can be used to send any meta value in string format
    Response:
    • Response Object : UploadVideo
    • Message: It is a simple string message
    • StatusCode : It returns an API status code (like 200,201,500,401)
    • Success : It returns boolean value, (true/false)
    • data : It returns uploaded data as result
  • To Upload Video on Signed URL
    API Class : CreatorInteractor
    Method : uploadContent()
    Used to upload/push the created video on the fetched S3 bucket URL. Refer getContentUploadUrl() to get the S3 url.
    Request:
    • Request Object : UploadVideoOnSignedUrlParams
    • Parameters
    • url : S3 Url
    • requestBody : Video Data(RequestBody)
    Response:
    • Response Object : UploadVideoOnSignedUrlInfo
    • Message : It is a simple string message
    • StatusCode : It returns an API status code (like 200,201,500,401)
    • Success : It returns boolean value, (true/false)
    • data : It returns uploaded data
  • To Fetch Auto Suggested Hashtag & Challenges
    API Class : CreatorInteractor
    Method : getHashtagSuggestion()
    Used to fetch suggested hashtags and challenges based on queried parameter.
    Request:
    • Request Object : CreatorParams
    • Parameters
    • search : search keyword
    • limit : How many auto suggestion results you want in a single response
    • offset : it's the current page/offset
    Response:
    • Response Object : AutoSuggestionInfo
    • Message: It is a simple string message
    • StatusCode : It returns an API status code (like 200,201,500,401)
    • Success: It returns boolean value, (true/false)
    • data : It return list of auto suggested hashtags and challenges
  • To Fetch List of Users To Tag On Post
    API Class : CreatorInteractor
    Method : getTagFriendList()
    Used to fetch the list of all users/friends while uploading the content. Refer uploadContentMetaData() to push the tagged user data on content.
    Request:
    • Request Object : CreatorParams
    • Parameters
    • search: search keyword
    • limit: How many users/friends you want in a single response
    • offset: it's the current page/offset
    Response:
    • Response Object : TagFriendList
    • Message: It is a simple string message
    • StatusCode : It returns an API status code (like 200,201,500,401)
    • Success: It returns boolean value, (true/false)
    • data : It returns list of users