GgitSignature

GgitSignature

Synopsis

                    GgitSignature;
struct              GgitSignatureClass;
GgitSignature *     ggit_signature_new                  (const gchar *name,
                                                         const gchar *email,
                                                         GDateTime *signature_time,
                                                         GTimeZone *signature_time_zone,
                                                         GError **error);
GgitSignature *     ggit_signature_new_now              (const gchar *name,
                                                         const gchar *email,
                                                         GError **error);
const gchar *       ggit_signature_get_name             (GgitSignature *signature);
const gchar *       ggit_signature_get_email            (GgitSignature *signature);
GDateTime *         ggit_signature_get_time             (GgitSignature *signature);
GTimeZone *         ggit_signature_get_time_zone        (GgitSignature *signature);

Object Hierarchy

  GObject
   +----GgitObjectFactoryBase
         +----GgitNative
               +----GgitSignature

Properties

  "encoding"                 gchar*                : Read / Write / Construct Only

Description

Details

GgitSignature

typedef struct _GgitSignature GgitSignature;

Represents an action signature.


struct GgitSignatureClass

struct GgitSignatureClass {
};

The class structure for GgitSignatureClass.


ggit_signature_new ()

GgitSignature *     ggit_signature_new                  (const gchar *name,
                                                         const gchar *email,
                                                         GDateTime *signature_time,
                                                         GTimeZone *signature_time_zone,
                                                         GError **error);

Creates a new GgitSignature. Name and e-mail are assumed to be in UTF-8.

name :

the name of the person.

email :

the email of the person.

signature_time :

the time when the action happened.

signature_time_zone :

the timezone for the time.

error :

a GError for error reporting, or NULL.

Returns :

a newly allocated GgitSignature. [transfer full]

ggit_signature_new_now ()

GgitSignature *     ggit_signature_new_now              (const gchar *name,
                                                         const gchar *email,
                                                         GError **error);

Creates a new GgitSignature with a timestamp of 'now'. Name and e-mail are assumed to be in UTF-8.

name :

the name of the person.

email :

the email of the person.

error :

a GError for error reporting, or NULL.

Returns :

a newly allocated GgitSignature. [transfer full]

ggit_signature_get_name ()

const gchar *       ggit_signature_get_name             (GgitSignature *signature);

Gets the name of the person.

signature :

a GgitSignature.

Returns :

the name of the person.

ggit_signature_get_email ()

const gchar *       ggit_signature_get_email            (GgitSignature *signature);

Gets the email of the person.

signature :

a GgitSignature.

Returns :

the email of the person.

ggit_signature_get_time ()

GDateTime *         ggit_signature_get_time             (GgitSignature *signature);

Gets the time in UTC when the action happened.

signature :

a GgitSignature.

Returns :

the time in UTC when the action happened. [transfer full]

ggit_signature_get_time_zone ()

GTimeZone *         ggit_signature_get_time_zone        (GgitSignature *signature);

Gets the timezone in which the action happened.

signature :

a GgitSignature.

Returns :

the timezone in which the action happened. [transfer full]

Property Details

The "encoding" property

  "encoding"                 gchar*                : Read / Write / Construct Only

Encoding.

Default value: NULL