GAP (Francy) - Chapter 8: Francy Messages

Goto Chapter: Top 1 2 3 4 5 6 7 8 9 Ind
[Top of Book] [Contents] [Previous Chapter] [Next Chapter]

[MathJax off]

8 Francy Messages
8.1 Categories
8.1-1 IsFrancyMessage
8.1-2 IsFrancyMessageType
8.2 Families
8.3 Representations
8.3-1 IsFrancyMessageRep
8.3-2 IsFrancyMessageTypeRep
8.4 Operations
8.4-1 FrancyMessage
8.5 Global
8.6 Attributes
8.6-1 Title
8.6-2 Title
8.6-3 SetTitle
8.6-4 Value
8.6-5 Value
8.6-6 SetValue

### 8 Francy Messages

`FrancyMessage` is an object that holds a message.

These messages can be used to provide information to users in the form of `SUCCESS`, `INFO`, `WARNING`, `ERROR`. Please see Francy-JS for client implementation.

#### 8.1 Categories

In this section we show the Francy FrancyMessage Categories.

##### 8.1-1 IsFrancyMessage

`‣ IsFrancyMessage`( arg ) | ( filter )

Returns: `true` or `false`

Identifies `FrancyMessage` objects.

##### 8.1-2 IsFrancyMessageType

`‣ IsFrancyMessageType`( arg ) | ( filter )

Returns: `true` or `false`

Identifies `MessageType` objects.

#### 8.2 Families

In this section we show the Francy FrancyMessage Families.

#### 8.3 Representations

In this section we show the Francy FrancyMessage Representations.

##### 8.3-1 IsFrancyMessageRep

`‣ IsFrancyMessageRep`( arg ) | ( filter )

Returns: `true` or `false`

Checks whether an `Object` has a `FrancyMessage` internal representation.

##### 8.3-2 IsFrancyMessageTypeRep

`‣ IsFrancyMessageTypeRep`( arg ) | ( filter )

Returns: `true` or `false`

Checks whether an `Object` has a `FrancyMessage` internal representation.

#### 8.4 Operations

In this section we show the Francy FrancyMessage Operations.

##### 8.4-1 FrancyMessage

`‣ FrancyMessage`( IsString, IsString ) | ( operation )

Returns: `FrancyMessage`

Adds an info label with the format label: value

#### 8.5 Global

In this section we show the Global Callback Francy Records for multi purpose.

#### 8.6 Attributes

In this section we show the Francy Core Attributes

##### 8.6-1 Title

`‣ Title`( arg ) | ( attribute )

Returns: `IsString` with the title of the object

A title on a `FrancyMessage` is used to display the title information to the user.

##### 8.6-2 Title

`‣ Title`( arg1 ) | ( function )

##### 8.6-3 SetTitle

`‣ SetTitle`( IsFrancyMessage, IsString ) | ( function )

Sets the title of the `FrancyMessage`.

##### 8.6-4 Value

`‣ Value`( arg ) | ( attribute )

Returns: `IsString` with the title of the object

A value on a `FrancyMessage` is used to display the information to the user.

##### 8.6-5 Value

`‣ Value`( arg1 ) | ( function )

##### 8.6-6 SetValue

`‣ SetValue`( IsFrancyMessage, IsString ) | ( function )

Sets the actual message of the `FrancyMessage`.

[Top of Book] [Contents] [Previous Chapter] [Next Chapter]
Goto Chapter: Top 1 2 3 4 5 6 7 8 9 Ind

generated by GAPDoc2HTML