Class RelationshipOptions
Defines the options to query the relationship data.
Inherited Members
Namespace: Unity.Services.Friends.Options
Assembly: Unity.Services.Friends.dll
Syntax
public class RelationshipOptionsMethods
WithMemberPresence(bool)
Defines whether or not to attach presence data to the member object
Declaration
public RelationshipOptions WithMemberPresence(bool withPresence)Parameters
| Type | Name | Description |
|---|---|---|
| bool | withPresence | Whether or not to attach presence data |
Returns
| Type | Description |
|---|---|
| RelationshipOptions | The RelationshipOptions with the updated presence flag |
WithMemberProfile(bool)
Defines whether or not to attach profile data to the member object
Declaration
public RelationshipOptions WithMemberProfile(bool withProfile)Parameters
| Type | Name | Description |
|---|---|---|
| bool | withProfile | whether or not to attach profile data |
Returns
| Type | Description |
|---|---|
| RelationshipOptions | The RelationshipOptions with the updated profile flag |
WithPaging(PagingOptions)
Defines the paging options for the results
Declaration
public RelationshipOptions WithPaging(PagingOptions pagingOptions)Parameters
| Type | Name | Description |
|---|---|---|
| PagingOptions | pagingOptions | Options to define the paging of the results |
Returns
| Type | Description |
|---|---|
| RelationshipOptions | Itself |
WithTypes(RelationshipType)
Defines the types of relationships to return as part of the query
Declaration
public RelationshipOptions WithTypes(RelationshipType relationshipType)Parameters
| Type | Name | Description |
|---|---|---|
| RelationshipType | relationshipType | the relationship types to query |
Returns
| Type | Description |
|---|---|
| RelationshipOptions | The RelationshipOptions with updated types |