ListRtcUserListRequest (Huawei Cloud SDK for CLOUDRTC 3.0.78 API)

java.lang.Object
- com.huaweicloud.sdk.cloudrtc.v1.model.ListRtcUserListRequest

public class ListRtcUserListRequest
extends Object

Request Object

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ListRtcUserListRequest.TypeEnum
查询模式，取值如下： - detail：会话级 - summary：用户级（默认）

Nested Classes
Modifier and Type	Class and Description
`static class`	`ListRtcUserListRequest.TypeEnum` 查询模式，取值如下： - detail：会话级 - summary：用户级（默认）

Constructor Summary

Constructors
Constructor and Description

ListRtcUserListRequest()

Constructors
Constructor and Description
`ListRtcUserListRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ListRtcUserListRequest`	`addIspItem(String ispItem)`
`ListRtcUserListRequest`	`addRegionItem(String regionItem)`
`ListRtcUserListRequest`	`addStateItem(String stateItem)`
`boolean`	`equals(Object o)`
`String`	`getApp()` 应用id
`String`	`getAuthorization()` 使用AK/SK方式认证时必选，携带的鉴权信息。
`String`	`getEndTime()` 查询结束时间。UTC时间，格式：YYYY-MM-DDThh:mm:ssZ，如2020-04-23T06:00:00Z，不写默认为当前时间。
`List<String>`	`getIsp()` 用户接入运营商
`Integer`	`getLimit()` 查询结果限制 minimum: 1 maximum: 100
`String`	`getNickname()` 用户昵称
`Integer`	`getOffset()` 查询偏移量 minimum: 0 maximum: 1844674407
`List<String>`	`getRegion()` 用户省份，支持省份名或缩写，如广东或者GD
`String`	`getRoomId()` 房间id
`String`	`getStartTime()` 查询起始时间。UTC时间，格式：YYYY-MM-DDThh:mm:ssZ，如2020-04-23T06:00:00Z，不写默认读取过去1小时数据数据。
`List<String>`	`getState()` 用户状态，取值如下： - FAIL：加入失败 - ONLINE：在线 - OFFLINE：离开
`ListRtcUserListRequest.TypeEnum`	`getType()` 查询模式，取值如下： - detail：会话级 - summary：用户级（默认）
`String`	`getUid()` 用户id
`String`	`getXProjectId()` 使用AK/SK方式认证时必选，携带项目ID信息，与路径参数中的项目ID相同。
`String`	`getXSdkDate()` 使用AK/SK方式认证时必选，请求的发生时间。
`int`	`hashCode()`
`void`	`setApp(String app)`
`void`	`setAuthorization(String authorization)`
`void`	`setEndTime(String endTime)`
`void`	`setIsp(List<String> isp)`
`void`	`setLimit(Integer limit)`
`void`	`setNickname(String nickname)`
`void`	`setOffset(Integer offset)`
`void`	`setRegion(List<String> region)`
`void`	`setRoomId(String roomId)`
`void`	`setStartTime(String startTime)`
`void`	`setState(List<String> state)`
`void`	`setType(ListRtcUserListRequest.TypeEnum type)`
`void`	`setUid(String uid)`
`void`	`setXProjectId(String xProjectId)`
`void`	`setXSdkDate(String xSdkDate)`
`String`	`toString()`
`ListRtcUserListRequest`	`withApp(String app)`
`ListRtcUserListRequest`	`withAuthorization(String authorization)`
`ListRtcUserListRequest`	`withEndTime(String endTime)`
`ListRtcUserListRequest`	`withIsp(java.util.function.Consumer<List<String>> ispSetter)`
`ListRtcUserListRequest`	`withIsp(List<String> isp)`
`ListRtcUserListRequest`	`withLimit(Integer limit)`
`ListRtcUserListRequest`	`withNickname(String nickname)`
`ListRtcUserListRequest`	`withOffset(Integer offset)`
`ListRtcUserListRequest`	`withRegion(java.util.function.Consumer<List<String>> regionSetter)`
`ListRtcUserListRequest`	`withRegion(List<String> region)`
`ListRtcUserListRequest`	`withRoomId(String roomId)`
`ListRtcUserListRequest`	`withStartTime(String startTime)`
`ListRtcUserListRequest`	`withState(java.util.function.Consumer<List<String>> stateSetter)`
`ListRtcUserListRequest`	`withState(List<String> state)`
`ListRtcUserListRequest`	`withType(ListRtcUserListRequest.TypeEnum type)`
`ListRtcUserListRequest`	`withUid(String uid)`
`ListRtcUserListRequest`	`withXProjectId(String xProjectId)`
`ListRtcUserListRequest`	`withXSdkDate(String xSdkDate)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail
- ListRtcUserListRequest
```
public ListRtcUserListRequest()
```

Method Detail

withAuthorization

public ListRtcUserListRequest withAuthorization(String authorization)

getAuthorization
```
public String getAuthorization()
```
使用AK/SK方式认证时必选，携带的鉴权信息。

Returns:

authorization

setAuthorization

public void setAuthorization(String authorization)

withXSdkDate

public ListRtcUserListRequest withXSdkDate(String xSdkDate)

getXSdkDate
```
public String getXSdkDate()
```
使用AK/SK方式认证时必选，请求的发生时间。

Returns:

xSdkDate

setXSdkDate

public void setXSdkDate(String xSdkDate)

withXProjectId

public ListRtcUserListRequest withXProjectId(String xProjectId)

getXProjectId
```
public String getXProjectId()
```
使用AK/SK方式认证时必选，携带项目ID信息，与路径参数中的项目ID相同。

Returns:

xProjectId

setXProjectId

public void setXProjectId(String xProjectId)

withApp

public ListRtcUserListRequest withApp(String app)

getApp
```
public String getApp()
```
应用id

Returns:

app

setApp
```
public void setApp(String app)
```

withRoomId

public ListRtcUserListRequest withRoomId(String roomId)

getRoomId
```
public String getRoomId()
```
房间id

Returns:

roomId

setRoomId
```
public void setRoomId(String roomId)
```

withUid

public ListRtcUserListRequest withUid(String uid)

getUid
```
public String getUid()
```
用户id

Returns:

uid

setUid
```
public void setUid(String uid)
```

withNickname

public ListRtcUserListRequest withNickname(String nickname)

getNickname
```
public String getNickname()
```
用户昵称

Returns:

nickname

setNickname

public void setNickname(String nickname)

withRegion

public ListRtcUserListRequest withRegion(List<String> region)

addRegionItem

public ListRtcUserListRequest addRegionItem(String regionItem)

withRegion

public ListRtcUserListRequest withRegion(java.util.function.Consumer<List<String>> regionSetter)

getRegion
```
public List<String> getRegion()
```
用户省份，支持省份名或缩写，如广东或者GD

Returns:

region

setRegion

public void setRegion(List<String> region)

withIsp

public ListRtcUserListRequest withIsp(List<String> isp)

addIspItem

public ListRtcUserListRequest addIspItem(String ispItem)

withIsp

public ListRtcUserListRequest withIsp(java.util.function.Consumer<List<String>> ispSetter)

getIsp
```
public List<String> getIsp()
```
用户接入运营商

Returns:

isp

setIsp
```
public void setIsp(List<String> isp)
```

withState

public ListRtcUserListRequest withState(List<String> state)

addStateItem

public ListRtcUserListRequest addStateItem(String stateItem)

withState

public ListRtcUserListRequest withState(java.util.function.Consumer<List<String>> stateSetter)

getState
```
public List<String> getState()
```
用户状态，取值如下： - FAIL：加入失败 - ONLINE：在线 - OFFLINE：离开

Returns:

state

setState

public void setState(List<String> state)

withStartTime

public ListRtcUserListRequest withStartTime(String startTime)

getStartTime
```
public String getStartTime()
```
查询起始时间。UTC时间，格式：YYYY-MM-DDThh:mm:ssZ，如2020-04-23T06:00:00Z，不写默认读取过去1小时数据数据。

Returns:

startTime

setStartTime

public void setStartTime(String startTime)

withEndTime

public ListRtcUserListRequest withEndTime(String endTime)

getEndTime
```
public String getEndTime()
```
查询结束时间。UTC时间，格式：YYYY-MM-DDThh:mm:ssZ，如2020-04-23T06:00:00Z，不写默认为当前时间。

Returns:

endTime

setEndTime

public void setEndTime(String endTime)

withLimit

public ListRtcUserListRequest withLimit(Integer limit)

getLimit
```
public Integer getLimit()
```
查询结果限制 minimum: 1 maximum: 100

Returns:

limit

setLimit
```
public void setLimit(Integer limit)
```

withOffset

public ListRtcUserListRequest withOffset(Integer offset)

getOffset
```
public Integer getOffset()
```
查询偏移量 minimum: 0 maximum: 1844674407

Returns:

offset

setOffset

public void setOffset(Integer offset)

withType

public ListRtcUserListRequest withType(ListRtcUserListRequest.TypeEnum type)

getType
```
public ListRtcUserListRequest.TypeEnum getType()
```
查询模式，取值如下： - detail：会话级 - summary：用户级（默认）

Returns:

type

setType

public void setType(ListRtcUserListRequest.TypeEnum type)

equals
```
public boolean equals(Object o)
```
Overrides:

equals in class Object

hashCode
```
public int hashCode()
```
Overrides:

hashCode in class Object

toString
```
public String toString()
```
Overrides:

toString in class Object

Class ListRtcUserListRequest

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ListRtcUserListRequest

Method Detail

withAuthorization

getAuthorization

setAuthorization

withXSdkDate

getXSdkDate

setXSdkDate

withXProjectId

getXProjectId

setXProjectId

withApp

getApp

setApp

withRoomId

getRoomId

setRoomId

withUid

getUid

setUid

withNickname

getNickname

setNickname

withRegion

addRegionItem

withRegion

getRegion

setRegion

withIsp

addIspItem

withIsp

getIsp

setIsp

withState

addStateItem

withState

getState

setState

withStartTime

getStartTime

setStartTime

withEndTime

getEndTime

setEndTime

withLimit

getLimit

setLimit

withOffset

getOffset

setOffset

withType

getType

setType

equals

hashCode

toString