Akonadi::DispatchModeAttribute

Search for usage in LXR

Akonadi::DispatchModeAttribute Class Reference

#include <dispatchmodeattribute.h>

Inheritance diagram for Akonadi::DispatchModeAttribute:

Public Types

enum  DispatchMode { Automatic , Manual }
 
- Public Types inherited from Akonadi::Attribute
typedef QList< Attribute * > List
 

Public Member Functions

 DispatchModeAttribute (DispatchMode mode=Automatic)
 
 ~DispatchModeAttribute () override
 
DispatchModeAttributeclone () const override
 
void deserialize (const QByteArray &data) override
 
DispatchMode dispatchMode () const
 
QDateTime sendAfter () const
 
QByteArray serialized () const override
 
void setDispatchMode (DispatchMode mode)
 
void setSendAfter (const QDateTime &date)
 
QByteArray type () const override
 
- Public Member Functions inherited from Akonadi::Attribute

Detailed Description

Attribute determining how and when a message from the outbox should be dispatched.

Messages can be sent immediately, sent only when the user explicitly requests it, or sent automatically at a certain date and time.

Author
Constantin Berzan exit3.nosp@m.219@.nosp@m.gmail.nosp@m..com
Since
4.4

Definition at line 29 of file dispatchmodeattribute.h.

Member Enumeration Documentation

◆ DispatchMode

Determines how the message is sent.

Enumerator
Automatic 

Send message as soon as possible, but no earlier than.

Manual 

specified by setSendAfter()

Send message only when the user requests so.

Definition at line 35 of file dispatchmodeattribute.h.

Constructor & Destructor Documentation

◆ DispatchModeAttribute()

DispatchModeAttribute::DispatchModeAttribute ( DispatchMode mode = Automatic)
explicit

Creates a new DispatchModeAttribute.

Definition at line 22 of file dispatchmodeattribute.cpp.

◆ ~DispatchModeAttribute()

DispatchModeAttribute::~DispatchModeAttribute ( )
overridedefault

Destroys the DispatchModeAttribute.

Member Function Documentation

◆ clone()

DispatchModeAttribute * DispatchModeAttribute::clone ( ) const
overridevirtual

Implements Akonadi::Attribute.

Definition at line 30 of file dispatchmodeattribute.cpp.

◆ deserialize()

void DispatchModeAttribute::deserialize ( const QByteArray & data)
overridevirtual

Implements Akonadi::Attribute.

Definition at line 60 of file dispatchmodeattribute.cpp.

◆ dispatchMode()

DispatchModeAttribute::DispatchMode DispatchModeAttribute::dispatchMode ( ) const
nodiscard

Returns the dispatch mode for the message.

See also
DispatchMode.

Definition at line 76 of file dispatchmodeattribute.cpp.

◆ sendAfter()

QDateTime DispatchModeAttribute::sendAfter ( ) const
nodiscard

Returns the date and time when the message should be sent.

Only valid if dispatchMode() is Automatic.

Definition at line 86 of file dispatchmodeattribute.cpp.

◆ serialized()

QByteArray DispatchModeAttribute::serialized ( ) const
nodiscardoverridevirtual

Implements Akonadi::Attribute.

Definition at line 43 of file dispatchmodeattribute.cpp.

◆ setDispatchMode()

void DispatchModeAttribute::setDispatchMode ( DispatchMode mode)

Sets the dispatch mode for the message.

Parameters
modethe dispatch mode to set
See also
DispatchMode.

Definition at line 81 of file dispatchmodeattribute.cpp.

◆ setSendAfter()

void DispatchModeAttribute::setSendAfter ( const QDateTime & date)

Sets the date and time when the message should be sent.

Parameters
datethe date and time to set
See also
setDispatchMode.

Definition at line 91 of file dispatchmodeattribute.cpp.

◆ type()

QByteArray DispatchModeAttribute::type ( ) const
nodiscardoverridevirtual

Implements Akonadi::Attribute.

Definition at line 37 of file dispatchmodeattribute.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Sat Dec 21 2024 17:05:31 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.