Skip to content

UsersApi.md

Latest commit

 

History

History
1105 lines (825 loc) · 31.1 KB

UsersApi.md

File metadata and controls

1105 lines (825 loc) · 31.1 KB

UsersApi

All URIs are relative to https://localhost

Method HTTP request Description
block POST /users/{id}/blocks Block an user
createRequest POST /users/{id}/requests Create a friend request to an user
deleteInvitation DELETE /invitations Delete a invitation
deleteRequest DELETE /users/{id}/requests Remove a friend request to an user
findFollow GET /users/{id}/follows Get users list an user follows
findUser GET /users/{id} Get information about an user
findUserChannel GET /users/{id}/channel Get a direct message channel to an user
findUserChannels GET /users/{id}/channels Get channels list an user channelJoined
findUserFeeds GET /users/{id}/feeds Get feeds list an user posted
findUserFeedsLiked GET /users/{id}/likes Get user's liked feeds
findUserFollowers GET /users/{id}/followers Get users list an user is followed by
findUserFriends GET /users/{id}/friends Get an user's friends list
findUserStatus GET /users/{id}/status Get user on
followUser POST /users/{id}/follow Follow an user
joinUser POST /users/{userId}/channels/{channelId}/join Join an user in a channel
leaveUser POST /users/{userId}/channels/{channelId}/leave Leave an user from a channel
muteUser POST /users/{id}/mutes Mute an user
reportUser POST /users/{id}/reports Report an user
unblock DELETE /users/{id}/blocks Unblock an user
unfollowUser DELETE /users/{id}/follow UnFollow an user
unfriend DELETE /users/{id}/friends Remove friendship to an user
unmuteUser DELETE /users/{id}/mutes Unmute an user
updateUserDisplayName PUT /users/{id}/display_name Change display name to session user

block

block(id)

Block an user

Example

// Import classes:
//import io.swagger.client.infrastructure.*
//import io.github.cactacea.backend.*

val apiInstance = UsersApi()
val id : java.math.BigDecimal = 8.14 // java.math.BigDecimal | User Identifier.
try {
    apiInstance.block(id)
} catch (e: ClientException) {
    println("4xx response calling UsersApi#block")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling UsersApi#block")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
id java.math.BigDecimal User Identifier.

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

createRequest

FriendRequestCreated createRequest(id)

Create a friend request to an user

Example

// Import classes:
//import io.swagger.client.infrastructure.*
//import io.github.cactacea.backend.*

val apiInstance = UsersApi()
val id : java.math.BigDecimal = 8.14 // java.math.BigDecimal | User Identifier.
try {
    val result : FriendRequestCreated = apiInstance.createRequest(id)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling UsersApi#createRequest")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling UsersApi#createRequest")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
id java.math.BigDecimal User Identifier.

Return type

FriendRequestCreated

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

deleteInvitation

deleteInvitation(channelId, userId)

Delete a invitation

Example

// Import classes:
//import io.swagger.client.infrastructure.*
//import io.github.cactacea.backend.*

val apiInstance = UsersApi()
val channelId : java.math.BigDecimal = 8.14 // java.math.BigDecimal | Channel Identifier.
val userId : java.math.BigDecimal = 8.14 // java.math.BigDecimal | User Identifier.
try {
    apiInstance.deleteInvitation(channelId, userId)
} catch (e: ClientException) {
    println("4xx response calling UsersApi#deleteInvitation")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling UsersApi#deleteInvitation")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
channelId java.math.BigDecimal Channel Identifier.
userId java.math.BigDecimal User Identifier.

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

deleteRequest

deleteRequest(id)

Remove a friend request to an user

Example

// Import classes:
//import io.swagger.client.infrastructure.*
//import io.github.cactacea.backend.*

val apiInstance = UsersApi()
val id : java.math.BigDecimal = 8.14 // java.math.BigDecimal | User identifier.
try {
    apiInstance.deleteRequest(id)
} catch (e: ClientException) {
    println("4xx response calling UsersApi#deleteRequest")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling UsersApi#deleteRequest")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
id java.math.BigDecimal User identifier.

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

findFollow

kotlin.Array<User> findFollow(id, userName, since, offset, count)

Get users list an user follows

Example

// Import classes:
//import io.swagger.client.infrastructure.*
//import io.github.cactacea.backend.*

val apiInstance = UsersApi()
val id : java.math.BigDecimal = 8.14 // java.math.BigDecimal | User Identifier.
val userName : kotlin.String = userName_example // kotlin.String | Filters users whose user name start of.
val since : java.math.BigDecimal = 8.14 // java.math.BigDecimal | Filters follower which started on since or later.
val offset : java.math.BigDecimal = 8.14 // java.math.BigDecimal | The offset of follower. By default the value is 0.
val count : java.math.BigDecimal = 8.14 // java.math.BigDecimal | Maximum number of follower returned on one result page. By default the value is 20 entries. The page size can never be larger than 50.
try {
    val result : kotlin.Array<User> = apiInstance.findFollow(id, userName, since, offset, count)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling UsersApi#findFollow")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling UsersApi#findFollow")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
id java.math.BigDecimal User Identifier.
userName kotlin.String Filters users whose user name start of. [optional]
since java.math.BigDecimal Filters follower which started on since or later. [optional]
offset java.math.BigDecimal The offset of follower. By default the value is 0. [optional]
count java.math.BigDecimal Maximum number of follower returned on one result page. By default the value is 20 entries. The page size can never be larger than 50. [optional]

Return type

kotlin.Array<User>

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

findUser

User findUser(id)

Get information about an user

Example

// Import classes:
//import io.swagger.client.infrastructure.*
//import io.github.cactacea.backend.*

val apiInstance = UsersApi()
val id : java.math.BigDecimal = 8.14 // java.math.BigDecimal | User identifier.
try {
    val result : User = apiInstance.findUser(id)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling UsersApi#findUser")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling UsersApi#findUser")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
id java.math.BigDecimal User identifier.

Return type

User

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

findUserChannel

Channel findUserChannel(id)

Get a direct message channel to an user

Example

// Import classes:
//import io.swagger.client.infrastructure.*
//import io.github.cactacea.backend.*

val apiInstance = UsersApi()
val id : java.math.BigDecimal = 8.14 // java.math.BigDecimal | User identifier.
try {
    val result : Channel = apiInstance.findUserChannel(id)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling UsersApi#findUserChannel")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling UsersApi#findUserChannel")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
id java.math.BigDecimal User identifier.

Return type

Channel

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

findUserChannels

kotlin.Array<Channel> findUserChannels(id, since, offset, count)

Get channels list an user channelJoined

Example

// Import classes:
//import io.swagger.client.infrastructure.*
//import io.github.cactacea.backend.*

val apiInstance = UsersApi()
val id : java.math.BigDecimal = 8.14 // java.math.BigDecimal | User identifier.
val since : java.math.BigDecimal = 8.14 // java.math.BigDecimal | Filters channels which started on since or later.
val offset : java.math.BigDecimal = 8.14 // java.math.BigDecimal | The offset of channels. By default the value is 0.
val count : java.math.BigDecimal = 8.14 // java.math.BigDecimal | Maximum number of channels returned on one result page. By default the value is 20 channels. The page size can never be larger than 50.
try {
    val result : kotlin.Array<Channel> = apiInstance.findUserChannels(id, since, offset, count)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling UsersApi#findUserChannels")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling UsersApi#findUserChannels")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
id java.math.BigDecimal User identifier.
since java.math.BigDecimal Filters channels which started on since or later. [optional]
offset java.math.BigDecimal The offset of channels. By default the value is 0. [optional]
count java.math.BigDecimal Maximum number of channels returned on one result page. By default the value is 20 channels. The page size can never be larger than 50. [optional]

Return type

kotlin.Array<Channel>

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

findUserFeeds

kotlin.Array<Feed> findUserFeeds(id, since, offset, count)

Get feeds list an user posted

Example

// Import classes:
//import io.swagger.client.infrastructure.*
//import io.github.cactacea.backend.*

val apiInstance = UsersApi()
val id : java.math.BigDecimal = 8.14 // java.math.BigDecimal | User Identifier.
val since : java.math.BigDecimal = 8.14 // java.math.BigDecimal | Filters feeds which started on since or later.
val offset : java.math.BigDecimal = 8.14 // java.math.BigDecimal | The offset of feeds. By default the value is 0.
val count : java.math.BigDecimal = 8.14 // java.math.BigDecimal | Maximum number of feeds returned on one result page. By default the value is 20 entries. The page size can never be larger than 50.
try {
    val result : kotlin.Array<Feed> = apiInstance.findUserFeeds(id, since, offset, count)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling UsersApi#findUserFeeds")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling UsersApi#findUserFeeds")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
id java.math.BigDecimal User Identifier.
since java.math.BigDecimal Filters feeds which started on since or later. [optional]
offset java.math.BigDecimal The offset of feeds. By default the value is 0. [optional]
count java.math.BigDecimal Maximum number of feeds returned on one result page. By default the value is 20 entries. The page size can never be larger than 50. [optional]

Return type

kotlin.Array<Feed>

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

findUserFeedsLiked

kotlin.Array<Feed> findUserFeedsLiked(id, since, offset, count)

Get user's liked feeds

Example

// Import classes:
//import io.swagger.client.infrastructure.*
//import io.github.cactacea.backend.*

val apiInstance = UsersApi()
val id : java.math.BigDecimal = 8.14 // java.math.BigDecimal | User Identifier.
val since : java.math.BigDecimal = 8.14 // java.math.BigDecimal | Filters feeds which started on since or later.
val offset : java.math.BigDecimal = 8.14 // java.math.BigDecimal | The offset of feeds. By default the value is 0.
val count : java.math.BigDecimal = 8.14 // java.math.BigDecimal | Maximum number of entries returned on one result page. By default the value is 20 entries. The page size can never be larger than 50.
try {
    val result : kotlin.Array<Feed> = apiInstance.findUserFeedsLiked(id, since, offset, count)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling UsersApi#findUserFeedsLiked")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling UsersApi#findUserFeedsLiked")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
id java.math.BigDecimal User Identifier.
since java.math.BigDecimal Filters feeds which started on since or later. [optional]
offset java.math.BigDecimal The offset of feeds. By default the value is 0. [optional]
count java.math.BigDecimal Maximum number of entries returned on one result page. By default the value is 20 entries. The page size can never be larger than 50. [optional]

Return type

kotlin.Array<Feed>

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

findUserFollowers

kotlin.Array<User> findUserFollowers(id, userName, since, offset, count)

Get users list an user is followed by

Example

// Import classes:
//import io.swagger.client.infrastructure.*
//import io.github.cactacea.backend.*

val apiInstance = UsersApi()
val id : java.math.BigDecimal = 8.14 // java.math.BigDecimal | User Identifier.
val userName : kotlin.String = userName_example // kotlin.String | Filters users whose user name start of.
val since : java.math.BigDecimal = 8.14 // java.math.BigDecimal | Filters followers which started on since or later.
val offset : java.math.BigDecimal = 8.14 // java.math.BigDecimal | The offset of followers. By default the value is 0.
val count : java.math.BigDecimal = 8.14 // java.math.BigDecimal | Maximum number of followers returned on one result page. By default the value is 20 entries. The page size can never be larger than 50.
try {
    val result : kotlin.Array<User> = apiInstance.findUserFollowers(id, userName, since, offset, count)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling UsersApi#findUserFollowers")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling UsersApi#findUserFollowers")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
id java.math.BigDecimal User Identifier.
userName kotlin.String Filters users whose user name start of. [optional]
since java.math.BigDecimal Filters followers which started on since or later. [optional]
offset java.math.BigDecimal The offset of followers. By default the value is 0. [optional]
count java.math.BigDecimal Maximum number of followers returned on one result page. By default the value is 20 entries. The page size can never be larger than 50. [optional]

Return type

kotlin.Array<User>

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

findUserFriends

kotlin.Array<User> findUserFriends(id, userName, since, offset, count)

Get an user's friends list

Example

// Import classes:
//import io.swagger.client.infrastructure.*
//import io.github.cactacea.backend.*

val apiInstance = UsersApi()
val id : java.math.BigDecimal = 8.14 // java.math.BigDecimal | User Identifier.
val userName : kotlin.String = userName_example // kotlin.String | Filters users whose user name start of.
val since : java.math.BigDecimal = 8.14 // java.math.BigDecimal | Filters friends which started on since or later.
val offset : java.math.BigDecimal = 8.14 // java.math.BigDecimal | The offset of friends. By default the value is 0.
val count : java.math.BigDecimal = 8.14 // java.math.BigDecimal | Maximum number of friends returned on one result page. By default the value is 20 entries. The page size can never be larger than 50.
try {
    val result : kotlin.Array<User> = apiInstance.findUserFriends(id, userName, since, offset, count)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling UsersApi#findUserFriends")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling UsersApi#findUserFriends")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
id java.math.BigDecimal User Identifier.
userName kotlin.String Filters users whose user name start of. [optional]
since java.math.BigDecimal Filters friends which started on since or later. [optional]
offset java.math.BigDecimal The offset of friends. By default the value is 0. [optional]
count java.math.BigDecimal Maximum number of friends returned on one result page. By default the value is 20 entries. The page size can never be larger than 50. [optional]

Return type

kotlin.Array<User>

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

findUserStatus

UserStatus findUserStatus(id)

Get user on

Example

// Import classes:
//import io.swagger.client.infrastructure.*
//import io.github.cactacea.backend.*

val apiInstance = UsersApi()
val id : java.math.BigDecimal = 8.14 // java.math.BigDecimal | User identifier.
try {
    val result : UserStatus = apiInstance.findUserStatus(id)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling UsersApi#findUserStatus")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling UsersApi#findUserStatus")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
id java.math.BigDecimal User identifier.

Return type

UserStatus

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

followUser

followUser(id)

Follow an user

Example

// Import classes:
//import io.swagger.client.infrastructure.*
//import io.github.cactacea.backend.*

val apiInstance = UsersApi()
val id : java.math.BigDecimal = 8.14 // java.math.BigDecimal | User Identifier.
try {
    apiInstance.followUser(id)
} catch (e: ClientException) {
    println("4xx response calling UsersApi#followUser")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling UsersApi#followUser")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
id java.math.BigDecimal User Identifier.

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

joinUser

joinUser(userId, channelId)

Join an user in a channel

Example

// Import classes:
//import io.swagger.client.infrastructure.*
//import io.github.cactacea.backend.*

val apiInstance = UsersApi()
val userId : java.math.BigDecimal = 8.14 // java.math.BigDecimal | User Identifier.
val channelId : java.math.BigDecimal = 8.14 // java.math.BigDecimal | Channel Identifier.
try {
    apiInstance.joinUser(userId, channelId)
} catch (e: ClientException) {
    println("4xx response calling UsersApi#joinUser")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling UsersApi#joinUser")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
userId java.math.BigDecimal User Identifier.
channelId java.math.BigDecimal Channel Identifier.

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

leaveUser

leaveUser(userId, channelId)

Leave an user from a channel

Example

// Import classes:
//import io.swagger.client.infrastructure.*
//import io.github.cactacea.backend.*

val apiInstance = UsersApi()
val userId : java.math.BigDecimal = 8.14 // java.math.BigDecimal | User Identifier.
val channelId : java.math.BigDecimal = 8.14 // java.math.BigDecimal | Channel Identifier.
try {
    apiInstance.leaveUser(userId, channelId)
} catch (e: ClientException) {
    println("4xx response calling UsersApi#leaveUser")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling UsersApi#leaveUser")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
userId java.math.BigDecimal User Identifier.
channelId java.math.BigDecimal Channel Identifier.

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

muteUser

muteUser(id)

Mute an user

Example

// Import classes:
//import io.swagger.client.infrastructure.*
//import io.github.cactacea.backend.*

val apiInstance = UsersApi()
val id : java.math.BigDecimal = 8.14 // java.math.BigDecimal | User Identifier.
try {
    apiInstance.muteUser(id)
} catch (e: ClientException) {
    println("4xx response calling UsersApi#muteUser")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling UsersApi#muteUser")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
id java.math.BigDecimal User Identifier.

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

reportUser

reportUser(id, body)

Report an user

Example

// Import classes:
//import io.swagger.client.infrastructure.*
//import io.github.cactacea.backend.*

val apiInstance = UsersApi()
val id : java.math.BigDecimal = 8.14 // java.math.BigDecimal | User Identifier.
val body : PostUserReportBody =  // PostUserReportBody | 
try {
    apiInstance.reportUser(id, body)
} catch (e: ClientException) {
    println("4xx response calling UsersApi#reportUser")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling UsersApi#reportUser")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
id java.math.BigDecimal User Identifier.
body PostUserReportBody

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

unblock

unblock(id)

Unblock an user

Example

// Import classes:
//import io.swagger.client.infrastructure.*
//import io.github.cactacea.backend.*

val apiInstance = UsersApi()
val id : java.math.BigDecimal = 8.14 // java.math.BigDecimal | User identifier.
try {
    apiInstance.unblock(id)
} catch (e: ClientException) {
    println("4xx response calling UsersApi#unblock")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling UsersApi#unblock")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
id java.math.BigDecimal User identifier.

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

unfollowUser

unfollowUser(id)

UnFollow an user

Example

// Import classes:
//import io.swagger.client.infrastructure.*
//import io.github.cactacea.backend.*

val apiInstance = UsersApi()
val id : java.math.BigDecimal = 8.14 // java.math.BigDecimal | User Identifier.
try {
    apiInstance.unfollowUser(id)
} catch (e: ClientException) {
    println("4xx response calling UsersApi#unfollowUser")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling UsersApi#unfollowUser")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
id java.math.BigDecimal User Identifier.

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

unfriend

unfriend(id)

Remove friendship to an user

Example

// Import classes:
//import io.swagger.client.infrastructure.*
//import io.github.cactacea.backend.*

val apiInstance = UsersApi()
val id : java.math.BigDecimal = 8.14 // java.math.BigDecimal | User identifier.
try {
    apiInstance.unfriend(id)
} catch (e: ClientException) {
    println("4xx response calling UsersApi#unfriend")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling UsersApi#unfriend")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
id java.math.BigDecimal User identifier.

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

unmuteUser

unmuteUser(id)

Unmute an user

Example

// Import classes:
//import io.swagger.client.infrastructure.*
//import io.github.cactacea.backend.*

val apiInstance = UsersApi()
val id : java.math.BigDecimal = 8.14 // java.math.BigDecimal | User identifier.
try {
    apiInstance.unmuteUser(id)
} catch (e: ClientException) {
    println("4xx response calling UsersApi#unmuteUser")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling UsersApi#unmuteUser")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
id java.math.BigDecimal User identifier.

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

updateUserDisplayName

updateUserDisplayName(id, body)

Change display name to session user

Example

// Import classes:
//import io.swagger.client.infrastructure.*
//import io.github.cactacea.backend.*

val apiInstance = UsersApi()
val id : java.math.BigDecimal = 8.14 // java.math.BigDecimal | User Identifier.
val body : PutUserDisplayNameBody =  // PutUserDisplayNameBody | 
try {
    apiInstance.updateUserDisplayName(id, body)
} catch (e: ClientException) {
    println("4xx response calling UsersApi#updateUserDisplayName")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling UsersApi#updateUserDisplayName")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
id java.math.BigDecimal User Identifier.
body PutUserDisplayNameBody

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined