Helix Web Services Client  1
Helix Web Services Client SDK for Qt Applications
Public Member Functions | List of all members
hws::Session Class Reference

The HWS Session, that owns our security token. More...

#include <Session.h>

Public Member Functions

 Session ()
 New empty session.
 
 Session (const Session &s)
 Copy a session from an existing Session state.
 
 ~Session ()
 Typical destructor.
 
Sessionoperator= (const Session &s)
 Copy session state from an existing session.
 
const QUrl & url () const
 
void setUrl (const QUrl &url)
 Set the Helix Web Services URL.
 
const QString & user () const
 The Perforce login associated with this session.
 
void setUser (const QString &user)
 Set the Perforce login name.
 
const QString & p4Ticket () const
 
void setP4Ticket (const QString &ticket)
 Set the P4 ticket to be used by the client.
 
QString toString ()
 Debugging representation of the Session.
 

Detailed Description

The HWS Session, that owns our security token.

This is the data associated with a web session. This should be locally serializable. Each web session gets assigned a security token for making subsequent calls to the web API.

Additionally, you also get a P4 Ticket for use on the local machine. This is an extension to our core authorization mechanism.

Member Function Documentation

const QString & hws::Session::p4Ticket ( ) const

The p4 ticket that should be host-locked to the user's machine that created the session.

const QUrl & hws::Session::url ( ) const

This is the Helix Web Services URL. You can't reuse a session from one server to another.


The documentation for this class was generated from the following files: