Package com.symphony.bdk.gen.api.model
Class RoomSearchCriteria
java.lang.Object
com.symphony.bdk.gen.api.model.RoomSearchCriteria
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
date="2024-03-26T16:14:56.804588655Z[Etc/UTC]")
public class RoomSearchCriteria
extends Object
Room Query Object. Used to specify the parameters for room search.
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic enum
Sort algorithm to be used. -
Field Summary
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionaddLabelsItem
(String labelsItem) boolean
Return true if this RoomSearchCriteria object is equal to o.Restrict the search to active/inactive rooms.Get creatorA list of room tag labels whose values will be queried.Get membergetOwner()
Get ownerRestrict the search to private rooms.getQuery()
The search query.Sort algorithm to be used.int
hashCode()
void
void
setCreator
(UserId creator) void
void
void
void
setPrivate
(Boolean _private) void
void
setSortOrder
(RoomSearchCriteria.SortOrderEnum sortOrder) sortOrder
(RoomSearchCriteria.SortOrderEnum sortOrder) toString()
-
Field Details
-
JSON_PROPERTY_QUERY
- See Also:
-
JSON_PROPERTY_LABELS
- See Also:
-
JSON_PROPERTY_ACTIVE
- See Also:
-
JSON_PROPERTY_PRIVATE
- See Also:
-
JSON_PROPERTY_OWNER
- See Also:
-
JSON_PROPERTY_CREATOR
- See Also:
-
JSON_PROPERTY_MEMBER
- See Also:
-
JSON_PROPERTY_SORT_ORDER
- See Also:
-
-
Constructor Details
-
RoomSearchCriteria
public RoomSearchCriteria()
-
-
Method Details
-
query
-
getQuery
The search query. Matches the room name and description.- Returns:
- query
-
setQuery
-
labels
-
addLabelsItem
-
getLabels
A list of room tag labels whose values will be queried.- Returns:
- labels
-
setLabels
-
active
-
getActive
Restrict the search to active/inactive rooms. If unspecified, search all rooms.- Returns:
- active
-
setActive
-
_private
-
getPrivate
Restrict the search to private rooms. If unspecified, search all rooms.- Returns:
- _private
-
setPrivate
-
owner
-
getOwner
Get owner- Returns:
- owner
-
setOwner
-
creator
-
getCreator
Get creator- Returns:
- creator
-
setCreator
-
member
-
getMember
Get member- Returns:
- member
-
setMember
-
sortOrder
-
getSortOrder
Sort algorithm to be used. Supports two values: \"BASIC\" (legacy algorithm) and \"RELEVANCE\" (enhanced algorithm).- Returns:
- sortOrder
-
setSortOrder
-
equals
Return true if this RoomSearchCriteria object is equal to o. -
hashCode
public int hashCode() -
toString
-