org.whispersystems.signalservice.api.messages

Class SignalServiceGroup

java.lang.Object

org.whispersystems.signalservice.api.messages.SignalServiceGroup

public class SignalServiceGroup
extends java.lang.Object

Group information to include in SignalServiceMessages destined to groups. This class represents a "context" that is included with Signal Service messages to make them group messages. There are three types of context: 1) Update -- Sent when either creating a group, or updating the properties of a group (such as the avatar icon, membership list, or title). 2) Deliver -- Sent when a message is to be delivered to an existing group. 3) Quit -- Sent when the sender wishes to leave an existing group.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SignalServiceGroup.Builder
static class	SignalServiceGroup.Type

Constructor Summary

Constructors

Constructor and Description
SignalServiceGroup(byte[] groupId) Construct a DELIVER group context.
SignalServiceGroup(SignalServiceGroup.Type type, byte[] groupId, java.lang.String name, java.util.List<java.lang.String> members, SignalServiceAttachment avatar) Construct a group context.

Method Summary

Modifier and Type	Method and Description
org.whispersystems.libsignal.util.guava.Optional<SignalServiceAttachment>	getAvatar()
byte[]	getGroupId()
org.whispersystems.libsignal.util.guava.Optional<java.util.List<java.lang.String>>	getMembers()
org.whispersystems.libsignal.util.guava.Optional<java.lang.String>	getName()
SignalServiceGroup.Type	getType()
static SignalServiceGroup.Builder	newBuilder(SignalServiceGroup.Type type)
static SignalServiceGroup.Builder	newUpdateBuilder()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SignalServiceGroup

public SignalServiceGroup(byte[] groupId)

Construct a DELIVER group context.

Parameters:

groupId -

SignalServiceGroup

public SignalServiceGroup(SignalServiceGroup.Type type,
                          byte[] groupId,
                          java.lang.String name,
                          java.util.List<java.lang.String> members,
                          SignalServiceAttachment avatar)

Construct a group context.

Parameters:

type - The group message type (update, deliver, quit).

groupId - The group ID.

name - The group title.

members - The group membership list.

avatar - The group avatar icon.

Method Detail

getGroupId

public byte[] getGroupId()

getType

public SignalServiceGroup.Type getType()

getName

public org.whispersystems.libsignal.util.guava.Optional<java.lang.String> getName()

getMembers

public org.whispersystems.libsignal.util.guava.Optional<java.util.List<java.lang.String>> getMembers()

getAvatar

public org.whispersystems.libsignal.util.guava.Optional<SignalServiceAttachment> getAvatar()

newUpdateBuilder

public static SignalServiceGroup.Builder newUpdateBuilder()

newBuilder

public static SignalServiceGroup.Builder newBuilder(SignalServiceGroup.Type type)