Documentation

CreateRequest extends Message
in package

Application

Generated from protobuf message <code>users.management.CreateRequest</code>

Properties

$address : mixed: Dirección postal del usuario. Es opcional.
$birthday : mixed: Fecha de nacimiento, y por tanto de cumpleaños.
$country : mixed: País del usuario. Es un campo libre sin validaciones. Es opcional.
$email : mixed: Email del usuario. Lo usará para iniciar sesión. No puede estar registrado de antes.
$gender : mixed: Sexo del usuario si quiere indicarlo. Por defecto será GENDER_UNKNOWN; que no es lo mismo que GENDER_UNSPECIFIED que significa que prefiere no decirlo.
$id_card : mixed: DNI español o cualquier otra tarjeta de identificación equivalente nacional o de otros paises.
$lastname : mixed: Apellidos del usuario. Es opcional.
$locality : mixed: Localidad del usuario. Es un campo libre sin validaciones. Es opcional.
$marketing : mixed: Flag que activa la posibilidad de enviar correos de marketing de nuevas campañas sin que el usuario se suscriba explícitamente a ellas.
$name : mixed: Nombre real del usuario. Es opcional.
$origin : mixed: Origen del usuario dentro de los distintos sitios de La Voz.
$password : mixed: Contraseña. Debe cumplir con las condiciones especificadas en la página de documentación que tenemos dedicada a ese tema. Es obligatorio especificar una contraseña durante el registro.
$phone : mixed: Teléfono del usuario. Es un campo libre sin validaciones.
$postal_code : mixed: Código postal. Es un campo libre sin validaciones. Es opcional.
$province : mixed: Provincia del usuario. Es un campo libre sin validaciones. Es opcional.
$recaptcha_token : mixed: reCAPTCHA de Google para evitar envío masivo de peticiones.
$third_party_profile : mixed: Flag que permite compartir el correo con terceros para enviarles correos comerciales y analizar su perfil.
$username : mixed: Nombre de usuario en el sistema. Es opcional. Es un alias, no tiene porqué parecerse a su nombre y apellidos reales.

Methods

__construct() : mixed: Constructor.
clearBirthday() : mixed
getAddress() : string: Dirección postal del usuario. Es opcional.
getBirthday() : Date|null: Fecha de nacimiento, y por tanto de cumpleaños.
getCountry() : string: País del usuario. Es un campo libre sin validaciones. Es opcional.
getEmail() : string: Email del usuario. Lo usará para iniciar sesión. No puede estar registrado de antes.
getGender() : int: Sexo del usuario si quiere indicarlo. Por defecto será GENDER_UNKNOWN; que no es lo mismo que GENDER_UNSPECIFIED que significa que prefiere no decirlo.
getIdCard() : string: DNI español o cualquier otra tarjeta de identificación equivalente nacional o de otros paises.
getLastname() : string: Apellidos del usuario. Es opcional.
getLocality() : string: Localidad del usuario. Es un campo libre sin validaciones. Es opcional.
getMarketing() : bool: Flag que activa la posibilidad de enviar correos de marketing de nuevas campañas sin que el usuario se suscriba explícitamente a ellas.
getName() : string: Nombre real del usuario. Es opcional.
getOrigin() : int: Origen del usuario dentro de los distintos sitios de La Voz.
getPassword() : string: Contraseña. Debe cumplir con las condiciones especificadas en la página de documentación que tenemos dedicada a ese tema. Es obligatorio especificar una contraseña durante el registro.
getPhone() : string: Teléfono del usuario. Es un campo libre sin validaciones.
getPostalCode() : string: Código postal. Es un campo libre sin validaciones. Es opcional.
getProvince() : string: Provincia del usuario. Es un campo libre sin validaciones. Es opcional.
getRecaptchaToken() : string: reCAPTCHA de Google para evitar envío masivo de peticiones.
getThirdPartyProfile() : bool: Flag que permite compartir el correo con terceros para enviarles correos comerciales y analizar su perfil.
getUsername() : string: Nombre de usuario en el sistema. Es opcional. Es un alias, no tiene porqué parecerse a su nombre y apellidos reales.
hasBirthday() : mixed
setAddress() : $this: Dirección postal del usuario. Es opcional.
setBirthday() : $this: Fecha de nacimiento, y por tanto de cumpleaños.
setCountry() : $this: País del usuario. Es un campo libre sin validaciones. Es opcional.
setEmail() : $this: Email del usuario. Lo usará para iniciar sesión. No puede estar registrado de antes.
setGender() : $this: Sexo del usuario si quiere indicarlo. Por defecto será GENDER_UNKNOWN; que no es lo mismo que GENDER_UNSPECIFIED que significa que prefiere no decirlo.
setIdCard() : $this: DNI español o cualquier otra tarjeta de identificación equivalente nacional o de otros paises.
setLastname() : $this: Apellidos del usuario. Es opcional.
setLocality() : $this: Localidad del usuario. Es un campo libre sin validaciones. Es opcional.
setMarketing() : $this: Flag que activa la posibilidad de enviar correos de marketing de nuevas campañas sin que el usuario se suscriba explícitamente a ellas.
setName() : $this: Nombre real del usuario. Es opcional.
setOrigin() : $this: Origen del usuario dentro de los distintos sitios de La Voz.
setPassword() : $this: Contraseña. Debe cumplir con las condiciones especificadas en la página de documentación que tenemos dedicada a ese tema. Es obligatorio especificar una contraseña durante el registro.
setPhone() : $this: Teléfono del usuario. Es un campo libre sin validaciones.
setPostalCode() : $this: Código postal. Es un campo libre sin validaciones. Es opcional.
setProvince() : $this: Provincia del usuario. Es un campo libre sin validaciones. Es opcional.
setRecaptchaToken() : $this: reCAPTCHA de Google para evitar envío masivo de peticiones.
setThirdPartyProfile() : $this: Flag que permite compartir el correo con terceros para enviarles correos comerciales y analizar su perfil.
setUsername() : $this: Nombre de usuario en el sistema. Es opcional. Es un alias, no tiene porqué parecerse a su nombre y apellidos reales.

$address

Dirección postal del usuario. Es opcional.


    protected
        mixed
    $address
     = ''

Ejemplo: c/Gran Vía 3, 4º F

Generated from protobuf field string address = 5;

$birthday

Fecha de nacimiento, y por tanto de cumpleaños.


    protected
        mixed
    $birthday
     = null

Generated from protobuf field .libs.datetime.Date birthday = 14;

$country

País del usuario. Es un campo libre sin validaciones. Es opcional.


    protected
        mixed
    $country
     = ''

Ejemplo: España

Generated from protobuf field string country = 9;

$email

Email del usuario. Lo usará para iniciar sesión. No puede estar registrado de antes.


    protected
        mixed
    $email
     = ''

Es obligatorio especificar un correo durante el registro.

Ejemplo: foo@example.com

Generated from protobuf field string email = 10;

$gender

Sexo del usuario si quiere indicarlo. Por defecto será GENDER_UNKNOWN; que no es lo mismo que GENDER_UNSPECIFIED que significa que prefiere no decirlo.


    protected
        mixed
    $gender
     = 0

Generated from protobuf field .users.users.Gender gender = 13;

$id_card

DNI español o cualquier otra tarjeta de identificación equivalente nacional o de otros paises.


    protected
        mixed
    $id_card
     = ''

Generated from protobuf field string id_card = 17;

$lastname

Apellidos del usuario. Es opcional.


    protected
        mixed
    $lastname
     = ''

Ejemplo: Pérez Gómez

Generated from protobuf field string lastname = 4;

$locality

Localidad del usuario. Es un campo libre sin validaciones. Es opcional.


    protected
        mixed
    $locality
     = ''

Ejemplo: Armilla

Generated from protobuf field string locality = 7;

$marketing

Flag que activa la posibilidad de enviar correos de marketing de nuevas campañas sin que el usuario se suscriba explícitamente a ellas.


    protected
        mixed
    $marketing
     = false

Generated from protobuf field bool marketing = 15;

$name

Nombre real del usuario. Es opcional.


    protected
        mixed
    $name
     = ''

Ejemplo: Manolo

Generated from protobuf field string name = 3;

$origin

Origen del usuario dentro de los distintos sitios de La Voz.


    protected
        mixed
    $origin
     = 0

Generated from protobuf field .users.users.Origin origin = 19;

$password

Contraseña. Debe cumplir con las condiciones especificadas en la página de documentación que tenemos dedicada a ese tema. Es obligatorio especificar una contraseña durante el registro.


    protected
        mixed
    $password
     = ''

Generated from protobuf field string password = 11;

$phone

Teléfono del usuario. Es un campo libre sin validaciones.


    protected
        mixed
    $phone
     = ''

Ejemplo: 958 11 22 33

Generated from protobuf field string phone = 12;

$postal_code

Código postal. Es un campo libre sin validaciones. Es opcional.


    protected
        mixed
    $postal_code
     = ''

Ejemplo: 18012

Generated from protobuf field string postal_code = 6;

$province

Provincia del usuario. Es un campo libre sin validaciones. Es opcional.


    protected
        mixed
    $province
     = ''

Ejemplo: Granada

Generated from protobuf field string province = 8;

$recaptcha_token

reCAPTCHA de Google para evitar envío masivo de peticiones.


    protected
        mixed
    $recaptcha_token
     = ''

Generated from protobuf field string recaptcha_token = 18;

$third_party_profile

Flag que permite compartir el correo con terceros para enviarles correos comerciales y analizar su perfil.


    protected
        mixed
    $third_party_profile
     = false

Generated from protobuf field bool third_party_profile = 16;

$username

Nombre de usuario en el sistema. Es opcional. Es un alias, no tiene porqué parecerse a su nombre y apellidos reales.


    protected
        mixed
    $username
     = ''

Ejemplo: ernestoalejo

Generated from protobuf field string username = 2;

__construct()

Constructor.


    public
                    __construct([array<string|int, mixed> $data = NULL ]) : mixed

Parameters

$data : array<string|int, mixed> = NULL

{ Optional. Data for populating the Message object.

@type string $username
      Nombre de usuario en el sistema. Es opcional. Es un alias, no tiene porqué
      parecerse a su nombre y apellidos reales.

      Ejemplo: ernestoalejo
@type string $name
      Nombre real del usuario. Es opcional.

      Ejemplo: Manolo
@type string $lastname
      Apellidos del usuario. Es opcional.

      Ejemplo: Pérez Gómez
@type string $address
      Dirección postal del usuario. Es opcional.

      Ejemplo: c/Gran Vía 3, 4º F
@type string $postal_code
      Código postal. Es un campo libre sin validaciones. Es opcional.

      Ejemplo: 18012
@type string $locality
      Localidad del usuario. Es un campo libre sin validaciones. Es opcional.

      Ejemplo: Armilla
@type string $province
      Provincia del usuario. Es un campo libre sin validaciones. Es opcional.

      Ejemplo: Granada
@type string $country
      País del usuario. Es un campo libre sin validaciones. Es opcional.

      Ejemplo: España
@type string $email
      Email del usuario. Lo usará para iniciar sesión. No puede estar registrado de antes.
      Es obligatorio especificar un correo durante el registro.

      Ejemplo: foo&#64;example.com
@type string $password
      Contraseña. Debe cumplir con las condiciones especificadas en la página de
      documentación que tenemos dedicada a ese tema. Es obligatorio especificar
      una contraseña durante el registro.
@type string $phone
      Teléfono del usuario. Es un campo libre sin validaciones.

      Ejemplo: 958 11 22 33
@type int $gender
      Sexo del usuario si quiere indicarlo. Por defecto será GENDER_UNKNOWN;
      que no es lo mismo que GENDER_UNSPECIFIED que significa que prefiere
      no decirlo.
@type \Libs\Datetime\Date $birthday
      Fecha de nacimiento, y por tanto de cumpleaños.
@type bool $marketing
      Flag que activa la posibilidad de enviar correos de marketing de nuevas
      campañas sin que el usuario se suscriba explícitamente a ellas.
@type bool $third_party_profile
      Flag que permite compartir el correo con terceros para enviarles correos
      comerciales y analizar su perfil.
@type string $id_card
      DNI español o cualquier otra tarjeta de identificación equivalente nacional o de otros paises.
@type string $recaptcha_token
      reCAPTCHA de Google para evitar envío masivo de peticiones.
@type int $origin
      Origen del usuario dentro de los distintos sitios de La Voz.

}

clearBirthday()


    public
                    clearBirthday() : mixed

getAddress()

Dirección postal del usuario. Es opcional.


    public
                    getAddress() : string

Ejemplo: c/Gran Vía 3, 4º F

Generated from protobuf field string address = 5;

Return values

string

getBirthday()

Fecha de nacimiento, y por tanto de cumpleaños.


    public
                    getBirthday() : Date|null

Generated from protobuf field .libs.datetime.Date birthday = 14;

Return values

Date|null

getCountry()

País del usuario. Es un campo libre sin validaciones. Es opcional.


    public
                    getCountry() : string

Ejemplo: España

Generated from protobuf field string country = 9;

Return values

string

getEmail()

Email del usuario. Lo usará para iniciar sesión. No puede estar registrado de antes.


    public
                    getEmail() : string

Es obligatorio especificar un correo durante el registro.

Ejemplo: foo@example.com

Generated from protobuf field string email = 10;

Return values

string

getGender()

Sexo del usuario si quiere indicarlo. Por defecto será GENDER_UNKNOWN; que no es lo mismo que GENDER_UNSPECIFIED que significa que prefiere no decirlo.


    public
                    getGender() : int

Generated from protobuf field .users.users.Gender gender = 13;

Return values

int

getIdCard()

DNI español o cualquier otra tarjeta de identificación equivalente nacional o de otros paises.


    public
                    getIdCard() : string

Generated from protobuf field string id_card = 17;

Return values

string

getLastname()

Apellidos del usuario. Es opcional.


    public
                    getLastname() : string

Ejemplo: Pérez Gómez

Generated from protobuf field string lastname = 4;

Return values

string

getLocality()

Localidad del usuario. Es un campo libre sin validaciones. Es opcional.


    public
                    getLocality() : string

Ejemplo: Armilla

Generated from protobuf field string locality = 7;

Return values

string

getMarketing()

Flag que activa la posibilidad de enviar correos de marketing de nuevas campañas sin que el usuario se suscriba explícitamente a ellas.


    public
                    getMarketing() : bool

Generated from protobuf field bool marketing = 15;

Return values

bool

getName()

Nombre real del usuario. Es opcional.


    public
                    getName() : string

Ejemplo: Manolo

Generated from protobuf field string name = 3;

Return values

string

getOrigin()

Origen del usuario dentro de los distintos sitios de La Voz.


    public
                    getOrigin() : int

Generated from protobuf field .users.users.Origin origin = 19;

Return values

int

getPassword()

Contraseña. Debe cumplir con las condiciones especificadas en la página de documentación que tenemos dedicada a ese tema. Es obligatorio especificar una contraseña durante el registro.


    public
                    getPassword() : string

Generated from protobuf field string password = 11;

Return values

string

getPhone()

Teléfono del usuario. Es un campo libre sin validaciones.


    public
                    getPhone() : string

Ejemplo: 958 11 22 33

Generated from protobuf field string phone = 12;

Return values

string

getPostalCode()

Código postal. Es un campo libre sin validaciones. Es opcional.


    public
                    getPostalCode() : string

Ejemplo: 18012

Generated from protobuf field string postal_code = 6;

Return values

string

getProvince()

Provincia del usuario. Es un campo libre sin validaciones. Es opcional.


    public
                    getProvince() : string

Ejemplo: Granada

Generated from protobuf field string province = 8;

Return values

string

getRecaptchaToken()

reCAPTCHA de Google para evitar envío masivo de peticiones.


    public
                    getRecaptchaToken() : string

Generated from protobuf field string recaptcha_token = 18;

Return values

string

getThirdPartyProfile()

Flag que permite compartir el correo con terceros para enviarles correos comerciales y analizar su perfil.


    public
                    getThirdPartyProfile() : bool

Generated from protobuf field bool third_party_profile = 16;

Return values

bool

getUsername()

Nombre de usuario en el sistema. Es opcional. Es un alias, no tiene porqué parecerse a su nombre y apellidos reales.


    public
                    getUsername() : string

Ejemplo: ernestoalejo

Generated from protobuf field string username = 2;

Return values

string

hasBirthday()


    public
                    hasBirthday() : mixed

setAddress()

Dirección postal del usuario. Es opcional.


    public
                    setAddress(string $var) : $this

Ejemplo: c/Gran Vía 3, 4º F

Generated from protobuf field string address = 5;

Parameters

$var : string

Return values

$this

setBirthday()

Fecha de nacimiento, y por tanto de cumpleaños.


    public
                    setBirthday(Date $var) : $this

Generated from protobuf field .libs.datetime.Date birthday = 14;

Parameters

$var : Date

Return values

$this

setCountry()

País del usuario. Es un campo libre sin validaciones. Es opcional.


    public
                    setCountry(string $var) : $this

Ejemplo: España

Generated from protobuf field string country = 9;

Parameters

$var : string

Return values

$this

setEmail()

Email del usuario. Lo usará para iniciar sesión. No puede estar registrado de antes.


    public
                    setEmail(string $var) : $this

Es obligatorio especificar un correo durante el registro.

Ejemplo: foo@example.com

Generated from protobuf field string email = 10;

Parameters

$var : string

Return values

$this

setGender()

Sexo del usuario si quiere indicarlo. Por defecto será GENDER_UNKNOWN; que no es lo mismo que GENDER_UNSPECIFIED que significa que prefiere no decirlo.


    public
                    setGender(int $var) : $this

Generated from protobuf field .users.users.Gender gender = 13;

Parameters

$var : int

Return values

$this

setIdCard()

DNI español o cualquier otra tarjeta de identificación equivalente nacional o de otros paises.


    public
                    setIdCard(string $var) : $this

Generated from protobuf field string id_card = 17;

Parameters

$var : string

Return values

$this

setLastname()

Apellidos del usuario. Es opcional.


    public
                    setLastname(string $var) : $this

Ejemplo: Pérez Gómez

Generated from protobuf field string lastname = 4;

Parameters

$var : string

Return values

$this

setLocality()

Localidad del usuario. Es un campo libre sin validaciones. Es opcional.


    public
                    setLocality(string $var) : $this

Ejemplo: Armilla

Generated from protobuf field string locality = 7;

Parameters

$var : string

Return values

$this

setMarketing()

Flag que activa la posibilidad de enviar correos de marketing de nuevas campañas sin que el usuario se suscriba explícitamente a ellas.


    public
                    setMarketing(bool $var) : $this

Generated from protobuf field bool marketing = 15;

Parameters

$var : bool

Return values

$this

setName()

Nombre real del usuario. Es opcional.


    public
                    setName(string $var) : $this

Ejemplo: Manolo

Generated from protobuf field string name = 3;

Parameters

$var : string

Return values

$this

setOrigin()

Origen del usuario dentro de los distintos sitios de La Voz.


    public
                    setOrigin(int $var) : $this

Generated from protobuf field .users.users.Origin origin = 19;

Parameters

$var : int

Return values

$this

setPassword()

Contraseña. Debe cumplir con las condiciones especificadas en la página de documentación que tenemos dedicada a ese tema. Es obligatorio especificar una contraseña durante el registro.


    public
                    setPassword(string $var) : $this

Generated from protobuf field string password = 11;

Parameters

$var : string

Return values

$this

setPhone()

Teléfono del usuario. Es un campo libre sin validaciones.


    public
                    setPhone(string $var) : $this

Ejemplo: 958 11 22 33

Generated from protobuf field string phone = 12;

Parameters

$var : string

Return values

$this

setPostalCode()

Código postal. Es un campo libre sin validaciones. Es opcional.


    public
                    setPostalCode(string $var) : $this

Ejemplo: 18012

Generated from protobuf field string postal_code = 6;

Parameters

$var : string

Return values

$this

setProvince()

Provincia del usuario. Es un campo libre sin validaciones. Es opcional.


    public
                    setProvince(string $var) : $this

Ejemplo: Granada

Generated from protobuf field string province = 8;

Parameters

$var : string

Return values

$this

setRecaptchaToken()

reCAPTCHA de Google para evitar envío masivo de peticiones.


    public
                    setRecaptchaToken(string $var) : $this

Generated from protobuf field string recaptcha_token = 18;

Parameters

$var : string

Return values

$this

setThirdPartyProfile()

Flag que permite compartir el correo con terceros para enviarles correos comerciales y analizar su perfil.


    public
                    setThirdPartyProfile(bool $var) : $this

Generated from protobuf field bool third_party_profile = 16;

Parameters

$var : bool

Return values

$this

setUsername()

Nombre de usuario en el sistema. Es opcional. Es un alias, no tiene porqué parecerse a su nombre y apellidos reales.


    public
                    setUsername(string $var) : $this

Ejemplo: ernestoalejo

Generated from protobuf field string username = 2;

Parameters

$var : string

Return values

$this

CreateRequest extends Message in package Application

Table of Contents

Properties

Methods

Properties

$address

$birthday

$country

$email

$gender

$id_card

$lastname

$locality

$marketing

$name

$origin

$password

$phone

$postal_code

$province

$recaptcha_token

$third_party_profile

$username

Methods

__construct()

Parameters

clearBirthday()

getAddress()

Return values

getBirthday()

Return values

getCountry()

Return values

getEmail()

Return values

getGender()

Return values

getIdCard()

Return values

getLastname()

Return values

getLocality()

Return values

getMarketing()

Return values

getName()

Return values

getOrigin()

Return values

getPassword()

Return values

getPhone()

Return values

getPostalCode()

Return values

getProvince()

Return values

getRecaptchaToken()

Return values

getThirdPartyProfile()

Return values

getUsername()

Return values

hasBirthday()

setAddress()

Parameters

Return values

setBirthday()

Parameters

Return values

setCountry()

Parameters

Return values

setEmail()

Parameters

Return values

setGender()

Parameters

Return values

setIdCard()

CreateRequest extends Message
in package

Application