Container collecting settings for logging in on a server, in particular a WebShare Cloud server for uploading (or downloading) WebShare data. More...

#include <lsloginsettings.h>

Inheritance diagram for LSLoginSettings:

Public Member Functions
bool	setSubdomain (const LSString &subdomain)
	Sets the subdomain of the server, e.g. More...

bool	setDomain (const LSString &domain)
	Sets the domain of the server, e.g. More...

bool	setUserName (const LSString &userName)
	Sets the user login name. More...

bool	setUserPassword (const LSString &userPassword)
	Sets the user password. More...

bool	check () const
	Carries out a complete check of all attributes. More...

Public Member Functions inherited from LSAttributeContainer
LSString	getTypeName () const
	Gets the type name of this instance. More...

LSString	getName () const
	Gets the name of the container. More...

LSResult::Result	setName (LSString name)
	Sets the name of the container. More...

LSString	getUuid () const
	Returns the unique id of the container. More...

LSString	assignUuid ()
	Assigns a unique id to the container if the container does not not yet have a unique id. More...

unsigned int	getNumAttributes () const
	Get the number of attributes in the container. More...

LSString	getAttributeName (unsigned int index) const
	Get the name of an attribute in the container. More...

unsigned int	getAttributeIndex (LSString name) const
	Get the index of an attribute in the container. More...

LSAttribute	getAttribute (unsigned int index) const
	Get an attribute based on its index. More...

LSAttribute	getAttribute (LSString name) const
	Get an attribute based on its name. More...

LSResult::Result	setAttribute (unsigned int index, const LSAttribute &attribute)
	Set an attribute based on its index. More...

LSResult::Result	setAttribute (LSString name, const LSAttribute &attribute)
	Set an attribute based on its name. More...

LSResult::Result	addCustomAttribute (LSString name, const LSAttribute &attribute)
	Add a new custom attribute to the container. More...

bool	removeCustomAttribute (LSString name)
	Remove a custom attribute from the container. More...

unsigned int	getNumFields () const
	Returns the number of fields in the container. More...

ref_ptr< LSAttributeContainer >	getField (unsigned int index) const
	Returns the field at position n in the container. More...

ref_ptr< LSAttributeContainer >	getField (const LSString &name) const
	Returns the field with the given name. More...

LSResult::Result	addField (const LSString &name, const LSString &typeName, ref_ptr< LSAttributeContainer > &fieldOut)
	Add a field to the container. More...

bool	rmField (const LSString &name)
	Removes the field with a given name from the container. More...

Static Public Member Functions
static ref_ptr< LSLoginSettings >	create ()

Static Public Attributes
static const LSString	ATTR_SUBDOMAIN
	Available attributes. More...

Additional Inherited Members
Protected Member Functions inherited from LSRefType
void	ref () const
	Increments the internal reference counter. More...

void	unref () const
	Decrements the internal reference counter. More...

Detailed Description

Container collecting settings for logging in on a server, in particular a WebShare Cloud server for uploading (or downloading) WebShare data.

All set methods return if setting the value was successful.

Version: SCENE API Version 2.0.19.

Member Function Documentation

◆ create()

static ref_ptr<LSLoginSettings> create ( )

static

Returns: A new instance of the implementation class. The constructor can't be called directly.

Version: SCENE API Version 2.0.19.

◆ setSubdomain()

bool setSubdomain ( const LSString & subdomain )

Sets the subdomain of the server, e.g.

L"preview". The URL is constructed like this: https://[subdomain].[domain] An arbitrary domain can be provided with the bracket notation: L"{https://my.example.com/?login}" In this case, the domain attribute is disregarded and can be left empty. The bracket notation is part of the subdomain instead of the domain for historical reasons. Default value = L"".

Returns: true if the provided setting is valid.

Version: SCENE API Version 2.0.19.

◆ setDomain()

bool setDomain ( const LSString & domain )

Sets the domain of the server, e.g.

L"websharecloud.com". See the description of the subdomain attribute. Default value = L"".

Returns: true if the provided setting is valid.

Version: SCENE API Version 2.0.19.

◆ setUserName()

bool setUserName ( const LSString & userName )

Sets the user login name.

This method must be called before connecting to the server since the default value L"" is invalid.

Returns: true if the provided setting is valid.

Version: SCENE API Version 2.0.19.

◆ setUserPassword()

bool setUserPassword ( const LSString & userPassword )

Sets the user password.

This method must be called before connecting to the server since the default value L"" is invalid.

Returns: true if the provided setting is valid.

Version: SCENE API Version 2.0.19.

◆ check()

bool check ( ) const

Carries out a complete check of all attributes.

This includes a consistency check involving several attributes, e.g. that not both subdomain and domain are empty.

Returns: true if all provided settings are valid and consistent.

Version: SCENE API Version 2.0.19.

Member Data Documentation

◆ ATTR_SUBDOMAIN

const LSString ATTR_SUBDOMAIN

static

Available attributes.

See the set methods below for default values and valid value ranges.

Public Member Functions

Static Public Member Functions

Static Public Attributes

Additional Inherited Members