ConversationStatus.Builder

public static final class ConversationStatus.Builder
extends Object

java.lang.Object
   ↳ android.app.people.ConversationStatus.Builder


Summary

Public constructors

Builder(String id, int activity)

Creates a new builder.

Public methods

ConversationStatus build()
ConversationStatus.Builder setAvailability(int availability)

Sets the availability of the conversation to provide a hint about how likely it is that the user would receive a timely response if they sent a message.

ConversationStatus.Builder setDescription(CharSequence description)

Sets a user visible description expanding on the conversation user(s)'s activity.

ConversationStatus.Builder setEndTimeMillis(long endTimeMs)

Sets an expiration time for this status.

ConversationStatus.Builder setIcon(Icon icon)

Sets an image representing the conversation user(s)'s activity.

ConversationStatus.Builder setStartTimeMillis(long startTimeMs)

Sets the time at which this status became valid.

Inherited methods

Public constructors

Builder

Added in API level 31
public Builder (String id, 
                int activity)

Creates a new builder.

Parameters
id String: The unique id for this status This value cannot be null.

activity int: The type of status Value is ConversationStatus.ACTIVITY_OTHER, ConversationStatus.ACTIVITY_BIRTHDAY, ConversationStatus.ACTIVITY_ANNIVERSARY, ConversationStatus.ACTIVITY_NEW_STORY, ConversationStatus.ACTIVITY_AUDIO, ConversationStatus.ACTIVITY_VIDEO, ConversationStatus.ACTIVITY_GAME, ConversationStatus.ACTIVITY_LOCATION, or ConversationStatus.ACTIVITY_UPCOMING_BIRTHDAY This value cannot be null.

Public methods

build

Added in API level 31
public ConversationStatus build ()

Returns
ConversationStatus This value cannot be null.

setAvailability

Added in API level 31
public ConversationStatus.Builder setAvailability (int availability)

Sets the availability of the conversation to provide a hint about how likely it is that the user would receive a timely response if they sent a message.

Parameters
availability int: Value is ConversationStatus.AVAILABILITY_UNKNOWN, ConversationStatus.AVAILABILITY_AVAILABLE, ConversationStatus.AVAILABILITY_BUSY, or ConversationStatus.AVAILABILITY_OFFLINE

Returns
ConversationStatus.Builder This value cannot be null.

setDescription

Added in API level 31
public ConversationStatus.Builder setDescription (CharSequence description)

Sets a user visible description expanding on the conversation user(s)'s activity.

Examples include: what media someone is watching or listening to, their approximate location, or what type of anniversary they are celebrating.

Parameters
description CharSequence: This value may be null.

Returns
ConversationStatus.Builder This value cannot be null.

setEndTimeMillis

Added in API level 31
public ConversationStatus.Builder setEndTimeMillis (long endTimeMs)

Sets an expiration time for this status.

The system will remove the status at this time if it hasn't already been withdrawn.

Parameters
endTimeMs long

Returns
ConversationStatus.Builder This value cannot be null.

setIcon

Added in API level 31
public ConversationStatus.Builder setIcon (Icon icon)

Sets an image representing the conversation user(s)'s activity.

Examples include: A still from a new story update, album art, or a map showing approximate location.

Parameters
icon Icon: This value may be null.

Returns
ConversationStatus.Builder This value cannot be null.

setStartTimeMillis

Added in API level 31
public ConversationStatus.Builder setStartTimeMillis (long startTimeMs)

Sets the time at which this status became valid.

Parameters
startTimeMs long

Returns
ConversationStatus.Builder This value cannot be null.