GI.Ggit.Objects.Signature

Represents an action signature.

Exported types

newtype Signature

Constructors

Signature (ManagedPtr Signature)

Instances

GObject Signature

Methods

gobjectType :: Signature -> IO GType

IsObject Signature

IsSignature Signature

IsObjectFactoryBase Signature

IsNative Signature

class GObject o => IsSignature o

Instances

(GObject a, UnknownAncestorError Constraint Signature a) => IsSignature a

IsSignature Signature

toSignature :: (MonadIO m, IsSignature o) => o -> m Signature

noSignature :: Maybe Signature

Methods

copy

signatureCopy

Arguments

:: (HasCallStack, MonadIO m, IsSignature a)

=> a

signature: a Signature.

-> m Signature

Returns: a Signature.

Create a copy of the signature.

getEmail

signatureGetEmail

Arguments

:: (HasCallStack, MonadIO m, IsSignature a)

=> a

signature: a Signature.

-> m Text

Returns: the email of the person.

Gets the email of the person.

getName

signatureGetName

Arguments

:: (HasCallStack, MonadIO m, IsSignature a)

=> a

signature: a Signature.

-> m Text

Returns: the name of the person.

Gets the name of the person.

getTime

signatureGetTime

Arguments

:: (HasCallStack, MonadIO m, IsSignature a)

=> a

signature: a Signature.

-> m DateTime

Returns: the time when the action happened.

Gets the time when the action happened. Note that the time is returned in the timezone of the commit (see ggit_signature_get_time_zone).

getTimeZone

signatureGetTimeZone

Arguments

:: (HasCallStack, MonadIO m, IsSignature a)

=> a

signature: a Signature.

-> m TimeZone

Returns: the timezone in which the action happened.

Gets the timezone in which the action happened.

new

signatureNew

Arguments

:: (HasCallStack, MonadIO m)

=> Text

name: the name of the person.

-> Text

email: the email of the person.

-> DateTime

signatureTime: the time when the action happened.

-> m Signature

Returns: a newly allocated Signature. (Can throw GError)

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

newNow

signatureNewNow

Arguments

:: (HasCallStack, MonadIO m)

=> Text

name: the name of the person.

-> Text

email: the email of the person.

-> m Signature

Returns: a newly allocated Signature. (Can throw GError)

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

Properties

encoding

constructSignatureEncoding :: IsSignature o => Text -> IO (GValueConstruct o)

getSignatureEncoding :: (MonadIO m, IsSignature o) => o -> m (Maybe Text)