API reference - Class QNetworkCookie

Notation used in Ruby API documentation

Description: Binding of QNetworkCookie

Sub-classes: RawForm

Public constructors

new QNetworkCookienew(string name = QByteArray(),
string value = QByteArray())
Constructor QNetworkCookie::QNetworkCookie(const QByteArray &name, const QByteArray &value)
new QNetworkCookienew(const QNetworkCookie other)Constructor QNetworkCookie::QNetworkCookie(const QNetworkCookie &other)

Public methods

[const]bool!=(const QNetworkCookie other)Method bool QNetworkCookie::operator!=(const QNetworkCookie &other)
[const]bool==(const QNetworkCookie other)Method bool QNetworkCookie::operator==(const QNetworkCookie &other)
void_assign(const QNetworkCookie other)Assigns another object to self
void_createEnsures the C++ object is created
void_destroyExplicitly destroys the object
[const]bool_destroyed?Returns a value indicating whether the object was already destroyed
[const]bool_is_const_object?Returns a value indicating whether the reference is a const reference
void_manageMarks the object as managed by the script side.
void_unmanageMarks the object as no longer owned by the script side.
QNetworkCookieassign(const QNetworkCookie other)Method QNetworkCookie &QNetworkCookie::operator=(const QNetworkCookie &other)
[const]stringdomainMethod QString QNetworkCookie::domain()
voiddomain=(string domain)Method void QNetworkCookie::setDomain(const QString &domain)
[const]new QNetworkCookie ptrdupCreates a copy of self
[const]QDateTimeexpirationDateMethod QDateTime QNetworkCookie::expirationDate()
voidexpirationDate=(const QDateTime date)Method void QNetworkCookie::setExpirationDate(const QDateTime &date)
[const]boolhttpOnlyMethod bool QNetworkCookie::isHttpOnly()
voidhttpOnly=(bool enable)Method void QNetworkCookie::setHttpOnly(bool enable)
[const]boolisHttpOnly?Method bool QNetworkCookie::isHttpOnly()
[const]boolisSecure?Method bool QNetworkCookie::isSecure()
[const]boolisSessionCookie?Method bool QNetworkCookie::isSessionCookie()
[const]stringnameMethod QByteArray QNetworkCookie::name()
voidname=(string cookieName)Method void QNetworkCookie::setName(const QByteArray &cookieName)
[const]stringpathMethod QString QNetworkCookie::path()
voidpath=(string path)Method void QNetworkCookie::setPath(const QString &path)
[const]boolsecureMethod bool QNetworkCookie::isSecure()
voidsecure=(bool enable)Method void QNetworkCookie::setSecure(bool enable)
voidsetDomain(string domain)Method void QNetworkCookie::setDomain(const QString &domain)
voidsetExpirationDate(const QDateTime date)Method void QNetworkCookie::setExpirationDate(const QDateTime &date)
voidsetHttpOnly(bool enable)Method void QNetworkCookie::setHttpOnly(bool enable)
voidsetName(string cookieName)Method void QNetworkCookie::setName(const QByteArray &cookieName)
voidsetPath(string path)Method void QNetworkCookie::setPath(const QString &path)
voidsetSecure(bool enable)Method void QNetworkCookie::setSecure(bool enable)
voidsetValue(string value)Method void QNetworkCookie::setValue(const QByteArray &value)
[const]stringtoRawForm(const QNetworkCookie_RawForm form = QNetworkCookie::Full)Method QByteArray QNetworkCookie::toRawForm(QNetworkCookie::RawForm form)
[const]stringvalueMethod QByteArray QNetworkCookie::value()
voidvalue=(string value)Method void QNetworkCookie::setValue(const QByteArray &value)

Public static methods and constants

[static,const]new QNetworkCookie_RawForm ptrFullEnum constant QNetworkCookie::Full
[static,const]new QNetworkCookie_RawForm ptrNameAndValueOnlyEnum constant QNetworkCookie::NameAndValueOnly
QNetworkCookie[]parseCookies(string cookieString)Static method QList<QNetworkCookie> QNetworkCookie::parseCookies(const QByteArray &cookieString)

Deprecated methods (protected, public, static, non-static and constructors)

voidcreateUse of this method is deprecated. Use _create instead
voiddestroyUse of this method is deprecated. Use _destroy instead
[const]booldestroyed?Use of this method is deprecated. Use _destroyed? instead
[const]boolis_const_object?Use of this method is deprecated. Use _is_const_object? instead

Detailed description

[const] bool !=(const QNetworkCookie other)

Description: Method bool QNetworkCookie::operator!=(const QNetworkCookie &other)

[const] bool ==(const QNetworkCookie other)

Description: Method bool QNetworkCookie::operator==(const QNetworkCookie &other)

[static,const] new QNetworkCookie_RawForm ptr Full

Description: Enum constant QNetworkCookie::Full

[static,const] new QNetworkCookie_RawForm ptr NameAndValueOnly

Description: Enum constant QNetworkCookie::NameAndValueOnly

void _assign(const QNetworkCookie other)

Description: Assigns another object to self

void _create

Description: Ensures the C++ object is created

Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created.

void _destroy

Description: Explicitly destroys the object

Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception. If the object is not owned by the script, this method will do nothing.

[const] bool _destroyed?

Description: Returns a value indicating whether the object was already destroyed

This method returns true, if the object was destroyed, either explicitly or by the C++ side. The latter may happen, if the object is owned by a C++ object which got destroyed itself.

[const] bool _is_const_object?

Description: Returns a value indicating whether the reference is a const reference

This method returns true, if self is a const reference. In that case, only const methods may be called on self.

void _manage

Description: Marks the object as managed by the script side.

After calling this method on an object, the script side will be responsible for the management of the object. This method may be called if an object is returned from a C++ function and the object is known not to be owned by any C++ instance. If necessary, the script side may delete the object if the script's reference is no longer required.

Usually it's not required to call this method. It has been introduced in version 0.24.

void _unmanage

Description: Marks the object as no longer owned by the script side.

Calling this method will make this object no longer owned by the script's memory management. Instead, the object must be managed in some other way. Usually this method may be called if it is known that some C++ object holds and manages this object. Technically speaking, this method will turn the script's reference into a weak reference. After the script engine decides to delete the reference, the object itself will still exist. If the object is not managed otherwise, memory leaks will occur.

Usually it's not required to call this method. It has been introduced in version 0.24.

QNetworkCookie assign(const QNetworkCookie other)

Description: Method QNetworkCookie &QNetworkCookie::operator=(const QNetworkCookie &other)

void create

Description: Ensures the C++ object is created

Use of this method is deprecated. Use _create instead

void destroy

Description: Explicitly destroys the object

Use of this method is deprecated. Use _destroy instead

[const] bool destroyed?

Description: Returns a value indicating whether the object was already destroyed

Use of this method is deprecated. Use _destroyed? instead

[const] string domain

Description: Method QString QNetworkCookie::domain()

Python specific notes:

The object exposes a readable attribute 'domain'. This is the getter.

void domain=(string domain)

Description: Method void QNetworkCookie::setDomain(const QString &domain)

Python specific notes:

The object exposes a writable attribute 'domain'. This is the setter.

[const] new QNetworkCookie ptr dup

Description: Creates a copy of self

[const] QDateTime expirationDate

Description: Method QDateTime QNetworkCookie::expirationDate()

Python specific notes:

The object exposes a readable attribute 'expirationDate'. This is the getter.

void expirationDate=(const QDateTime date)

Description: Method void QNetworkCookie::setExpirationDate(const QDateTime &date)

Python specific notes:

The object exposes a writable attribute 'expirationDate'. This is the setter.

[const] bool httpOnly

Description: Method bool QNetworkCookie::isHttpOnly()

Python specific notes:

The object exposes a readable attribute 'httpOnly'. This is the getter.

void httpOnly=(bool enable)

Description: Method void QNetworkCookie::setHttpOnly(bool enable)

Python specific notes:

The object exposes a writable attribute 'httpOnly'. This is the setter.

[const] bool isHttpOnly?

Description: Method bool QNetworkCookie::isHttpOnly()

Python specific notes:

The object exposes a readable attribute 'httpOnly'. This is the getter.

[const] bool isSecure?

Description: Method bool QNetworkCookie::isSecure()

Python specific notes:

The object exposes a readable attribute 'secure'. This is the getter.

[const] bool isSessionCookie?

Description: Method bool QNetworkCookie::isSessionCookie()

[const] bool is_const_object?

Description: Returns a value indicating whether the reference is a const reference

Use of this method is deprecated. Use _is_const_object? instead

[const] string name

Description: Method QByteArray QNetworkCookie::name()

Python specific notes:

The object exposes a readable attribute 'name'. This is the getter.

void name=(string cookieName)

Description: Method void QNetworkCookie::setName(const QByteArray &cookieName)

Python specific notes:

The object exposes a writable attribute 'name'. This is the setter.

[static] new QNetworkCookie new(string name = QByteArray(),string value = QByteArray())

Description: Constructor QNetworkCookie::QNetworkCookie(const QByteArray &name, const QByteArray &value)

This method creates an object of class QNetworkCookie.

Python specific notes:

This method is the default initializer of the object

[static] new QNetworkCookie new(const QNetworkCookie other)

Description: Constructor QNetworkCookie::QNetworkCookie(const QNetworkCookie &other)

This method creates an object of class QNetworkCookie.

Python specific notes:

This method is the default initializer of the object

[static] QNetworkCookie[] parseCookies(string cookieString)

Description: Static method QList<QNetworkCookie> QNetworkCookie::parseCookies(const QByteArray &cookieString)

This method is static and can be called without an instance.

[const] string path

Description: Method QString QNetworkCookie::path()

Python specific notes:

The object exposes a readable attribute 'path'. This is the getter.

void path=(string path)

Description: Method void QNetworkCookie::setPath(const QString &path)

Python specific notes:

The object exposes a writable attribute 'path'. This is the setter.

[const] bool secure

Description: Method bool QNetworkCookie::isSecure()

Python specific notes:

The object exposes a readable attribute 'secure'. This is the getter.

void secure=(bool enable)

Description: Method void QNetworkCookie::setSecure(bool enable)

Python specific notes:

The object exposes a writable attribute 'secure'. This is the setter.

void setDomain(string domain)

Description: Method void QNetworkCookie::setDomain(const QString &domain)

Python specific notes:

The object exposes a writable attribute 'domain'. This is the setter.

void setExpirationDate(const QDateTime date)

Description: Method void QNetworkCookie::setExpirationDate(const QDateTime &date)

Python specific notes:

The object exposes a writable attribute 'expirationDate'. This is the setter.

void setHttpOnly(bool enable)

Description: Method void QNetworkCookie::setHttpOnly(bool enable)

Python specific notes:

The object exposes a writable attribute 'httpOnly'. This is the setter.

void setName(string cookieName)

Description: Method void QNetworkCookie::setName(const QByteArray &cookieName)

Python specific notes:

The object exposes a writable attribute 'name'. This is the setter.

void setPath(string path)

Description: Method void QNetworkCookie::setPath(const QString &path)

Python specific notes:

The object exposes a writable attribute 'path'. This is the setter.

void setSecure(bool enable)

Description: Method void QNetworkCookie::setSecure(bool enable)

Python specific notes:

The object exposes a writable attribute 'secure'. This is the setter.

void setValue(string value)

Description: Method void QNetworkCookie::setValue(const QByteArray &value)

Python specific notes:

The object exposes a writable attribute 'value'. This is the setter.

[const] string toRawForm(const QNetworkCookie_RawForm form = QNetworkCookie::Full)

Description: Method QByteArray QNetworkCookie::toRawForm(QNetworkCookie::RawForm form)

[const] string value

Description: Method QByteArray QNetworkCookie::value()

Python specific notes:

The object exposes a readable attribute 'value'. This is the getter.

void value=(string value)

Description: Method void QNetworkCookie::setValue(const QByteArray &value)

Python specific notes:

The object exposes a writable attribute 'value'. This is the setter.