Package im.getsocial.sdk.communities
Class SearchQuery
- java.lang.Object
-
- im.getsocial.sdk.communities.SearchQuery
-
public final class SearchQuery extends java.lang.Object
Query to do a global search.
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static SearchQuery
all()
Get all entities.static SearchQuery
find(java.lang.String searchTerm)
Find entities.java.lang.String
getSearchTerm()
SearchQuery
inEntities(java.util.List<CommunitiesEntityType> entities)
Search in specific entities.SearchQuery
withLabels(java.util.List<java.lang.String> labels)
Get entities with the specified labels.SearchQuery
withProperties(java.util.Map<java.lang.String,java.lang.String> properties)
Get entities with the specified properties.
-
-
-
Method Detail
-
all
public static SearchQuery all()
Get all entities.- Returns:
- new instance.
-
find
public static SearchQuery find(java.lang.String searchTerm)
Find entities.- Parameters:
searchTerm
- string to search.- Returns:
- new instance.
-
inEntities
public SearchQuery inEntities(java.util.List<CommunitiesEntityType> entities)
Search in specific entities.- Parameters:
entities
- List of entities to search.- Returns:
- new query.
-
withLabels
public SearchQuery withLabels(java.util.List<java.lang.String> labels)
Get entities with the specified labels.- Parameters:
labels
- List of labels.- Returns:
- new query.
-
withProperties
public SearchQuery withProperties(java.util.Map<java.lang.String,java.lang.String> properties)
Get entities with the specified properties.- Parameters:
properties
- Properties.- Returns:
- new query.
-
getSearchTerm
public java.lang.String getSearchTerm()
- Returns:
- string passed to
find(String)
. Empty string if searching for all entities.
-
-