Package io.getstream.chat.java.models

Class Campaign

java.lang.Object

io.getstream.chat.java.models.Campaign

public class Campaign
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Campaign.CampaignCreateRequestData
static class	Campaign.CampaignCreateResponse
static class	Campaign.CampaignDeleteRequest
static class	Campaign.CampaignDeleteResponse
static class	Campaign.CampaignGetRequest
static class	Campaign.CampaignGetResponse
static class	Campaign.CampaignQueryRequestData
static class	Campaign.CampaignQueryResponse
static class	Campaign.CampaignStartRequestData
static class	Campaign.CampaignStartResponse
static class	Campaign.CampaignStopRequest
static class	Campaign.CampaignStopResponse
static class	Campaign.CampaignUpdateRequestData
static class	Campaign.CampaignUpdateResponse
static class	Campaign.ChannelTemplate
static class	Campaign.MemberTemplate
static class	Campaign.MessageTemplate

Constructor Summary

Constructors

Constructor	Description
Campaign()

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(java.lang.Object other)
static @NotNull Campaign.CampaignCreateRequestData.CampaignCreateRequest	create()	Creates a create request
static @NotNull Campaign.CampaignDeleteRequest	delete(@NotNull java.lang.String id)	Creates a delete request
boolean	equals(java.lang.Object o)
static @NotNull Campaign.CampaignGetRequest	get(@NotNull java.lang.String id)	Creates a get request
@Nullable Campaign.ChannelTemplate	getChannelTemplate()
@Nullable java.lang.Boolean	getCreateChannels()
@NotNull java.util.Date	getCreatedAt()
@Nullable java.lang.String	getDescription()
@NotNull java.lang.String	getId()
@Nullable Campaign.MessageTemplate	getMessageTemplate()
@Nullable java.lang.String	getName()
@Nullable java.util.Date	getScheduledFor()
@Nullable java.util.List<java.lang.String>	getSegmentIds()
@NotNull java.lang.String	getSenderId()
@Nullable java.lang.Boolean	getSkipPush()
@Nullable java.lang.Boolean	getSkipWebhook()
@Nullable java.lang.String	getStatus()
@Nullable java.util.Date	getStopAt()
@NotNull java.util.Date	getUpdatedAt()
@Nullable java.util.List<java.lang.String>	getUserIds()
int	hashCode()
static @NotNull Campaign.CampaignQueryRequestData.CampaignQueryRequest	query()	Creates a query request
void	setChannelTemplate(@Nullable Campaign.ChannelTemplate channelTemplate)
void	setCreateChannels(@Nullable java.lang.Boolean createChannels)
void	setCreatedAt(@NotNull java.util.Date createdAt)
void	setDescription(@Nullable java.lang.String description)
void	setId(@NotNull java.lang.String id)
void	setMessageTemplate(@Nullable Campaign.MessageTemplate messageTemplate)
void	setName(@Nullable java.lang.String name)
void	setScheduledFor(@Nullable java.util.Date scheduledFor)
void	setSegmentIds(@Nullable java.util.List<java.lang.String> segmentIds)
void	setSenderId(@NotNull java.lang.String senderId)
void	setSkipPush(@Nullable java.lang.Boolean skipPush)
void	setSkipWebhook(@Nullable java.lang.Boolean skipWebhook)
void	setStatus(@Nullable java.lang.String status)
void	setStopAt(@Nullable java.util.Date stopAt)
void	setUpdatedAt(@NotNull java.util.Date updatedAt)
void	setUserIds(@Nullable java.util.List<java.lang.String> userIds)
static @NotNull Campaign.CampaignStartRequestData.CampaignStartRequest	start(@NotNull java.lang.String id)	Creates a start request
static @NotNull Campaign.CampaignStopRequest	stop(@NotNull java.lang.String id)	Creates a stop request
java.lang.String	toString()
static @NotNull Campaign.CampaignUpdateRequestData.CampaignUpdateRequest	update(@NotNull java.lang.String id)	Creates an update request

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Campaign

public Campaign()

Method Detail

create

@NotNull
public static @NotNull Campaign.CampaignCreateRequestData.CampaignCreateRequest create()

Creates a create request

Returns:

the created request

get

@NotNull
public static @NotNull Campaign.CampaignGetRequest get(@NotNull
                                                       @NotNull java.lang.String id)

Creates a get request

Parameters:

id - the campaign id

Returns:

the created request

update

@NotNull
public static @NotNull Campaign.CampaignUpdateRequestData.CampaignUpdateRequest update(@NotNull
                                                                                       @NotNull java.lang.String id)

Creates an update request

Parameters:

id - the campaign id

Returns:

the created request

delete

@NotNull
public static @NotNull Campaign.CampaignDeleteRequest delete(@NotNull
                                                             @NotNull java.lang.String id)

Creates a delete request

Parameters:

id - the campaign id

Returns:

the created request

start

@NotNull
public static @NotNull Campaign.CampaignStartRequestData.CampaignStartRequest start(@NotNull
                                                                                    @NotNull java.lang.String id)

Creates a start request

Parameters:

id - the campaign id

Returns:

the created request

stop

@NotNull
public static @NotNull Campaign.CampaignStopRequest stop(@NotNull
                                                         @NotNull java.lang.String id)

Creates a stop request

Parameters:

id - the campaign id

Returns:

the created request

query

@NotNull
public static @NotNull Campaign.CampaignQueryRequestData.CampaignQueryRequest query()

Creates a query request

Returns:

the created request

getId

@NotNull
public @NotNull java.lang.String getId()

getName

@Nullable
public @Nullable java.lang.String getName()

getDescription

@Nullable
public @Nullable java.lang.String getDescription()

getSenderId

@NotNull
public @NotNull java.lang.String getSenderId()

getStatus

@Nullable
public @Nullable java.lang.String getStatus()

getSegmentIds

@Nullable
public @Nullable java.util.List<java.lang.String> getSegmentIds()

getUserIds

@Nullable
public @Nullable java.util.List<java.lang.String> getUserIds()

getMessageTemplate

@Nullable
public @Nullable Campaign.MessageTemplate getMessageTemplate()

getChannelTemplate

@Nullable
public @Nullable Campaign.ChannelTemplate getChannelTemplate()

getCreateChannels

@Nullable
public @Nullable java.lang.Boolean getCreateChannels()

getSkipPush

@Nullable
public @Nullable java.lang.Boolean getSkipPush()

getSkipWebhook

@Nullable
public @Nullable java.lang.Boolean getSkipWebhook()

getScheduledFor

@Nullable
public @Nullable java.util.Date getScheduledFor()

getStopAt

@Nullable
public @Nullable java.util.Date getStopAt()

getCreatedAt

@NotNull
public @NotNull java.util.Date getCreatedAt()

getUpdatedAt

@NotNull
public @NotNull java.util.Date getUpdatedAt()

setId

public void setId(@NotNull
                  @NotNull java.lang.String id)

setName

public void setName(@Nullable
                    @Nullable java.lang.String name)

setDescription

public void setDescription(@Nullable
                           @Nullable java.lang.String description)

setSenderId

public void setSenderId(@NotNull
                        @NotNull java.lang.String senderId)

setStatus

public void setStatus(@Nullable
                      @Nullable java.lang.String status)

setSegmentIds

public void setSegmentIds(@Nullable
                          @Nullable java.util.List<java.lang.String> segmentIds)

setUserIds

public void setUserIds(@Nullable
                       @Nullable java.util.List<java.lang.String> userIds)

setMessageTemplate

public void setMessageTemplate(@Nullable
                               @Nullable Campaign.MessageTemplate messageTemplate)

setChannelTemplate

public void setChannelTemplate(@Nullable
                               @Nullable Campaign.ChannelTemplate channelTemplate)

setCreateChannels

public void setCreateChannels(@Nullable
                              @Nullable java.lang.Boolean createChannels)

setSkipPush

public void setSkipPush(@Nullable
                        @Nullable java.lang.Boolean skipPush)

setSkipWebhook

public void setSkipWebhook(@Nullable
                           @Nullable java.lang.Boolean skipWebhook)

setScheduledFor

public void setScheduledFor(@Nullable
                            @Nullable java.util.Date scheduledFor)

setStopAt

public void setStopAt(@Nullable
                      @Nullable java.util.Date stopAt)

setCreatedAt

public void setCreatedAt(@NotNull
                         @NotNull java.util.Date createdAt)

setUpdatedAt

public void setUpdatedAt(@NotNull
                         @NotNull java.util.Date updatedAt)

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

canEqual

protected boolean canEqual(java.lang.Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object