MailInterface

<< 目次を表示 >>

ページ位置:  API・アドイン・スクリプト > API > リファレンス > MailInterfaceオブジェクト >

MailInterface

MailInterfaceオブジェクトは、RepositoryのGetMailInterfaceで取得できます。このオブジェクトを利用することで、Enterprise Architect内部のメッセージ機能を利用できます。APIを利用して、自動的にメッセージを送信したい場合に便利です。

 

また、メッセージにモデルへのハイパーリンクを添付する場合に利用できる操作も提供しています。

 

 

属性

属性

R/W

説明

ObjectType

ObjectType

R

オブジェクトを識別するために利用します。

MessagingEnabled

bool

R

現在のプロジェクトで、メッセージ機能が利用可能かどうかを返します。

 

 

操作

操作

戻り値の型

説明

ComposeMailMessage

(string InitialRecipientGUID,

string InitialSubject,

messageflag InitialFlag,

string InitialMessageText)

bool

新しいメッセージを新規に作成します。指定した引数に合わせて、メッセージの初期値が設定されます。メッセージの送信画面が開きます。

この操作を実行しても、メッセージは送信されません。

 

引数:

  • InitialRecipientGUID: string - メッセージの送信先を、Enterprise Architect内部のGUIDで指定します。
  • InitialSubject: string - メッセージのタイトルです。
  • InitialFlag: MessageFlag - メッセージのフラグの種類・色を指定します。
  • InitialMessageText: string - メッセージの本文の文字列です。

GetAttributeHyperlink

(string AttributeGUID,

string LinkText)

string

指定した属性へのハイパーリンクを含む文字列を返します。

 

引数:

  • AttributeGUID: string - 対象の属性のGUIDです。
  • LinkText: string - リンクされる対象の文字列です。

GetDiagramHyperlink

(string DiagramGUID,

string LinkText)

string

指定したダイアグラムへのハイパーリンクを含む文字列を返します。

 

引数:

  • DiagramGUID: string - 対象のダイアグラムのGUIDです。
  • LinkText: string - リンクされる対象の文字列です。

GetElementHyperlink

(string ElementGUID,

string LinkText)

string

指定した要素へのハイパーリンクを含む文字列を返します。

 

引数:

  • ElementGUID: string - 対象の要素のGUIDです。
  • LinkText: string - リンクされる対象の文字列です。

GetFileHyperlink

(string FilePath,

string LinkText)

string

指定したファイルへのハイパーリンクを含む文字列を返します。

 

引数:

  • FilePath: string - 対象のファイルのフルパスです。
  • LinkText: string - リンクされる対象の文字列です。 (ファイル名など)

GetLastError()

string

最後に発生したエラーの詳細情報です。

GetMethodHyperlink

(string MethodGUID,

string LinkText)

string

 

指定した操作へのハイパーリンクを含む文字列を返します。

 

引数:

  • MethodGUID: string - 対象の操作のGUIDです。
  • LinkText: string - リンクされる対象の文字列です。

GetPackageHyperlink

(string PackageGUID,

string LinkText)

string

指定したパッケージへのハイパーリンクを含む文字列を返します。

 

引数:

  • PackageGUID: string - 対象のパッケージのGUIDです。
  • LinkText: string - リンクされる対象の文字列です。

GetRecipientGUID

(string UserName)

string

指定したEnterprise ArchitectユーザーのGUIDを返します。

 

引数:

  • UserName: string - 対象のユーザーの名前です。

GetWebHyperlink

(string URL,

string LinkText)

string

 

指定したURLへのハイパーリンクを含む文字列を返します。

 

引数:

  • URL: string - 対象のURLです。
  • LinkText: string - リンクされる対象の文字列です。

SendMailMessage

(string RecipientGUID,

string Subject,

messageflag Flag,

string MessageText)

bool

 

新しいメッセージを新規に作成し、メッセージを送信します。

 

引数:

  • RecipientGUID: string - メッセージの送信先を、Enterprise Architect内部のGUIDで指定します。
  • Subject: string - メッセージのタイトルです。
  • Flag: MessageFlag - メッセージのフラグの種類・色を指定します。
  • MessageText: string - メッセージの本文の文字列です。

 

注意:

このオブジェクトは過去の不整合を修正した関係で、「MessageInterface」オブジェクトとして参照・利用できる場合があります。機能はMailInterfaceオブジェクトと完全に同一です。