サーバー側の開発 (ワークスペース X++ API)

重要

財務と運用 (Dynamics 365) モバイル アプリおよびプラットフォームは、非推奨になりました。 詳細については、削除済みまたは非推奨のプラットフォーム機能を参照してください。

クラス SysAppActionAttribute

ワークスペースのアクションを定義するメソッドの修飾に使用される SysAppActionAttribute

メソッド

メソッド名	返品	説明
新規	無効	SysAppActionAttribute クラスの新しいインスタンスを作成する
pageMethodName	str	このタスクが存在するページを形成する Page メソッド名を取得します
actionTitle	str	アクション タイトルの取得
actionDescription	str	アクション説明の取得
crudOperationType	SysAppCRUDOperation	作成、更新、削除などの CRUD 操作タイプを取得

メソッド new

SysAppActionAttribute クラスの新しいインスタンスを作成する

public void new ([str _actionTitle], [str _actionDescription], [SysAppCRUDOperation _crudOperationType], [str _pageMethodName])

パラメーター

パラメーター名	パラメーター タイプ	オプション	説明
_actionTitle	str	はい	アクション タイトル
_actionDescription	str	はい	アクション説明
_crudOperationType	SysAppCRUDOperation	はい	作成、更新、削除などの CRUD の操作
_pageMethodName	str	はい	親ページを構築するメソッドの名前

メソッド pageMethodName

このタスクが存在するページを形成する Page メソッド名を取得します

public str pageMethodName ()

戻り値

このタスクが存在するページを形成する Page メソッド名

メソッド actionTitle

アクション タイトルの取得

public str actionTitle ()

戻り値

アクション タイトル

メソッド actionDescription

アクション説明の取得

public str actionDescription ()

戻り値

ページの説明

メソッド crudOperationType

作成、更新、削除などの CRUD 操作タイプを取得

public SysAppCRUDOperation crudOperationType ()

戻り値

作成、更新、削除などの CRUD 操作タイプ

クラス SysAppActionMetadata

このクラスを使用すると、AX モバイル ワーク スペースのアクション メタデータにアクセスして更新できます。

方法

メソッド名	返品	説明
新規	無効
getActionName	str	アクション名を返します
actionTitle	str	アクション タイトルの取得または設定
actionDescription	str	アクションの説明の取得または設定
actionHidden	ブール値	アクションが非表示かどうかを取得または設定
actionOrder	int	アクション順序の取得または設定
getControl	SysAppControlMetadata	指定されたコントロールの名前を持つ現在のアクションのコントロールを返します
getControlEnumerator	MapEnumerator	アクションの制御を列挙するために使用できるマップ列挙子を返します。 ここで、Key はコントロール名で、値は SysAppControlMetadata 型です

メソッド new

public void new (Microsoft.Dynamics.Client.ServerForm.App.TaskMetadata _taskmetadata)

パラメーター

パラメーター名	パラメーター タイプ	オプション	説明
_taskmetadata	Microsoft.Dynamics.Client.ServerForm.App.TaskMetadata	False

メソッド getActionName

アクション名を返します

public str getActionName ()

戻り値

アクション名

メソッド actionTitle

アクション タイトルの取得または設定

public str actionTitle ([str _actionTitle])

パラメーター

パラメーター名	パラメーター タイプ	オプション	説明
_actionTitle	str	はい	アクション タイトル

戻り値

アクション タイトル

メソッド actionDescription

アクションの説明の取得または設定

public str actionDescription ([str _actionDescription])

パラメーター

パラメーター名	パラメーター タイプ	オプション	説明
_actionDescription	str	はい	アクションの説明

戻り値

アクションの説明

メソッド actionHidden

アクションが非表示かどうかを取得または設定

public boolean actionHidden ([boolean _actionHidden])

パラメーター

パラメーター名	パラメーター タイプ	オプション	説明
_actionHidden	ブール値	はい	アクションの非表示値

戻り値

アクションが非表示の場合は true。それ以外の場合は、false。

メソッド actionOrder

アクション順序の取得または設定

public int actionOrder ([int _actionOrder])

パラメーター

パラメーター名	パラメーター タイプ	オプション	説明
_actionOrder	int	はい	アクションの順序

戻り値

アクションの順序

メソッド getControl

指定されたコントロールの名前を持つ現在のアクションのコントロールを返します

public SysAppControlMetadata getControl (str _controlName)

パラメーター

パラメーター名	パラメーター タイプ	オプション	説明
_controlName	str	False	コントロールを検索するために使用されるコントロール名

戻り値

指定されたコントロール名を持つコントロールがアクションに存在する場合、SysAppControlMetadata のオブジェクトは返されます。それ以外の場合は null

メソッド getControlEnumerator

アクションの制御を列挙するために使用できるマップ列挙子を返します。 ここで、Key はコントロール名で、値は SysAppControlMetadata 型です

public MapEnumerator getControlEnumerator ()

戻り値

マップ列挙子

クラス SysAppAttributeHelper

拡張されたすべてのクラスから属性を取得するための SysAppAttributeHelper クラス

メソッド

メソッド名	返品	説明
getAttributeFromClass	SysAttribute	クラスから属性を取得します

メソッド getAttributeFromClass

クラスから属性を取得します

public SysAttribute getAttributeFromClass (SysDictClass _sysClass, SysAppAttributeType _attributeType)

パラメーター

パラメーター名	パラメーター タイプ	オプション	説明
_sysClass	SysDictClass	False	属性が必要なクラス
_attributeType	SysAppAttributeType	False	SysAppEntityAttribute と同様の属性の型

クラス SysAppCollectionAttribute

リスト コントロールを形成するメソッドの修飾に使用される SysAppCollectionAttribute

メソッド

メソッド名	返品	説明
新規	無効	コンストラクター

メソッド new

コンストラクター

public void new (str _itemContractName, [str _label], [str _relationshipName])

パラメーター

パラメーター名	パラメーター タイプ	オプション	説明
_itemContractName	str	False	リスト項目のデータ契約名
_label	str	はい	リスト コントロール ラベル
_relationshipName	str	はい	関係名。 既定では、一覧項目のエンティティ名はリレーションシップ名として使用します。

クラス SysAppControlMetadata

容易にする管理対象 ControlMetadata オブジェクト上の X++ ラッパーを表します。 X++ オブジェクトとしてオブジェクトを回覧

メソッド

メソッド名	返品	説明
新規	無効	コントロールのメタデータの新しいインスタンスを作成する
getBaseLanguageId	str	アプリケーションの基本言語 ID を返します
getControlName	str	コントロール名を返します
controlLabel	str	コントロール ラベルの取得および設定
controlHidden	ブール値	コントロールを非表示にするかどうかの取得および設定
controlOrder	int	コントロール順序の取得または設定
controlMandatory	ブール値	必須コントロールの取得または設定
controlAllowNegative	ブール値	負の値を許可するコントロールを取得または設定します
controlMaxLength	int	コントロールの最大長の取得または設定
getProperty	anytype	キーによって参照されるコントロール プロパティを取得します。
setProperty	無効	キーによって参照されるコントロール プロパティを設定します。

メソッド new

コントロールのメタデータの新しいインスタンスを作成する

public void new (Microsoft.Dynamics.Client.ServerForm.App.ControlMetadata _controlMetadata, [str _baseLanguageId])

パラメーター

パラメーター名	パラメーター タイプ	オプション	説明
_controlMetadata	Microsoft.Dynamics.Client.ServerForm.App.ControlMetadata	False	controlMetadata オブジェクト
_baseLanguageId	str	はい	基本言語

メソッド getBaseLanguageId

アプリケーションの基本言語 ID を返します

public str getBaseLanguageId ()

戻り値

基本言語 ID

メソッド getControlName

コントロール名を返します

public str getControlName ()

戻り値

コントロールの名前。

メソッド controlLabel

コントロール ラベルの取得および設定

public str controlLabel ([str _controlLabel])

パラメーター

パラメーター名	パラメーター タイプ	オプション	説明
_controlLabel	str	はい	コントロール ラベル

戻り値

コントロール ラベル

メソッド controlHidden

コントロールを非表示にするかどうかの取得および設定

public boolean controlHidden ([boolean _controlHidden])

パラメーター

パラメーター名	パラメーター タイプ	オプション	説明
_controlHidden	ブール値	はい	非表示値の制御

戻り値

コントロールが非表示の場合は true。それ以外の場合は、false。

メソッド controlOrder

コントロール順序の取得または設定

public int controlOrder ([int _controlOrder])

パラメーター

パラメーター名	パラメーター タイプ	オプション	説明
_controlOrder	int	はい	コントロール順序

戻り値

コントロール順序

メソッド controlMandatory

必須コントロールの取得または設定

public boolean controlMandatory ([boolean _controlMandatory])

パラメーター

パラメーター名	パラメーター タイプ	オプション	説明
_controlMandatory	ブール値	はい	必須のコントロール

戻り値

必須のコントロール

メソッド controlAllowNegative

負の値を許可するコントロールを取得または設定します

public boolean controlAllowNegative ([boolean _controlAllowNegative])

パラメーター

パラメーター名	パラメーター タイプ	オプション	説明
_controlAllowNegative	ブール型	True	コントロールは負の値を許可します

戻り値

コントロールは負の値を許可します

メソッド controlMaxLength

コントロールの最大長の取得または設定

public int controlMaxLength ([int _controlMaxLength])

パラメーター

パラメーター名	パラメーター タイプ	オプション	説明
_controlMaxLength	int	はい	コントロールの最大長

戻り値

コントロールの最大長

メソッド getProperty

キーによって参照されるコントロール プロパティを取得します。

public anytype getProperty (str _key)

パラメーター

パラメーター名	パラメーター タイプ	オプション	説明
_key	str	False	コントロール プロパティの名前。

戻り値

プロパティ値。

メソッド setProperty

キーによって参照されるコントロール プロパティを設定します。

public void setProperty (str _key, anytype _value)

パラメーター

パラメーター名	パラメーター タイプ	オプション	説明
_key	str	False	コントロール プロパティの名前。
_value	anytype	False	コントロール プロパティの値

クラス SysAppEntityAttribute

データ契約エンティティの修飾に使用される SysAppEntityAttribute

メソッド

メソッド名	返品	説明
新規	無効	コンストラクター
名前	str	エンティティの名前の取得
entityKey	str	エンティティ キーの取得

メソッド new

コンストラクター

public void new (str _name, str _entityKey)

パラメーター

パラメーター名	パラメーター タイプ	オプション	説明
_name	str	False	エンティティ名
_entityKey	str	False	エンティティのキーの名前

メソッド名

エンティティの名前の取得

public str name ()

戻り値

エンティティの名前

メソッド entityKey

エンティティ キーの取得

public str entityKey ()

戻り値

エンティティ キー

クラス SysAppEntityContext

エンティティ コンテキストを定義するために使用される SysAppEntityContext

メソッド

メソッド名	返品	説明
constructFromParams	SysAppEntityContext	entityName と entityId から SysAppEntityContext を構築します。
constructFromBuffer	SysAppEntityContext	テーブル バッファーから SysAppEntityContext を構築
entityName	str	フィルターを適用するエンティティ名
entityId	str	フィルターを適用するフィールド値

メソッド constructFromParams

entityName と entityId から SysAppEntityContext を構築します。

public SysAppEntityContext constructFromParams (str _entityName, str _entityId)

パラメーター

パラメーター名	パラメーター タイプ	オプション	説明
_entityName	str	False	エンティティ名
_entityId	str	False	エンティティの値

戻り値

SysAppEntityContext のインスタンス

メソッド constructFromBuffer

テーブル バッファーから SysAppEntityContext を構築

public SysAppEntityContext constructFromBuffer (Common _tableBuffer)

パラメーター

パラメーター名	パラメーター タイプ	オプション	説明
_tableBuffer	共通	False	エンティティを形成するテーブル バッファ

戻り値

SysAppEntityContext のインスタンス

メソッド entityName

フィルターを適用するエンティティ名

public str entityName ([str _entityName])

パラメーター

パラメーター名	パラメーター タイプ	オプション	説明
_entityName	str	はい	エンティティ名

戻り値

エンティティ名

メソッド entityId

フィルターを適用するフィールド値

public str entityId ([str _entityId])

パラメーター

パラメーター名	パラメーター タイプ	オプション	説明
_entityId	str	はい	エンティティの値

戻り値

エンティティの値

クラス SysAppFieldAttribute

連結フィールドを形成するメソッドの修飾に使用される SysAppFieldAttribute

メソッド

メソッド名	返品	説明
新規	無効	SysAppFieldAttribute クラスの新しいインスタンスを作成する

メソッド new

SysAppFieldAttribute クラスの新しいインスタンスを作成する

public void new (str _fieldName, str _label)

パラメーター

パラメーター名	パラメーター タイプ	オプション	説明
_fieldName	str	False	コントロールがバインドされるエンティティ フィールド名
_label	str	False	コントロール ラベル

クラス SysAppFieldMultiSelectHelper

D365 モバイル アプリケーションで使用される複数のシナリオを選択するためのヘルパー メソッドを提供するヘルパー クラス。

メソッド

メソッド名	返品	説明
新規	無効	SysAppFieldMultiSelectHelper クラスの新しいインスタンスを作成する
getSelectedRecIds	コンテナー	選択されたレコードの recIds のコンテナーを返します
getSelectedValues	コンテナー	選択した値のコンテナーを返します
getSelectedRecords	共通	選択したすべてのレコードを含むバッファーを返します。 バッファが temp. としてマークされます。 後で、while-Select はすべてのレコードを反復処理するために使用できます
setControlValue	無効	複数選択コントロール値を設定するセッター

メソッド new

SysAppFieldMultiSelectHelper クラスの新しいインスタンスを作成する

public void new (TableId _multiSelectTableId, FieldId _valueFieldId, FormStringControl _multiSelectControl)

パラメーター

パラメーター名	パラメーター タイプ	オプション	説明
_multiSelectTableId	TableId	False	フィールドのバッキング tableId。
_valueFieldId	FieldId	False	複数選択コントロールに表示されるフィールドの fieldId
_multiSelectControl	FormStringControl	False	複数選択コントロールになる文字列コントロール

メソッド getSelectedRecIds

選択されたレコードの recIds のコンテナーを返します

public container getSelectedRecIds ()

戻り値

選択されたレコードの recOds のコンテナー

メソッド getSelectedValues

選択した値のコンテナーを返します

public container getSelectedValues ()

戻り値

選択した値のコンテナー

メソッド getSelectedRecords

選択したすべてのレコードを含むバッファーを返します。 バッファが temp. としてマークされます。 後で、while-Select はすべてのレコードを反復処理するために使用できます

public Common getSelectedRecords ()

戻り値

選択したすべてのレコードを含むバッファー

メソッド setControlValue

複数選択コントロール値を設定するセッター

public void setControlValue (str _value)

パラメーター

パラメーター名	パラメーター タイプ	オプション	説明
_value	str	False	SysAppFieldMultiSelectHelper によって使用されるコロン区切り値

クラス SysAppFilterContext

コンテキスト値を保持している SysAppFilterContext クラス

メソッド

メソッド名	返品	説明
entityName	str	フィルターを適用するエンティティ名
filterFieldName	str	フィルターを適用するフィールド名
filterFieldValueList	リスト	フィルター処理動作に基づくフィルターの一覧フィールド値の取得
演算子	str	結果のフェッチに使用される演算子
addFilterFieldValue	無効	フィルター フィールド値の追加

メソッド entityName

フィルターを適用するエンティティ名

public str entityName ([str _entityName])

パラメーター

パラメーター名	パラメーター タイプ	オプション	説明
_entityName	str	はい	フィルターを適用するエンティティ名

戻り値

フィルターを適用するエンティティ名

メソッド filterFieldName

フィルターを適用するフィールド名

public str filterFieldName ([str _filterFieldName])

パラメーター

パラメーター名	パラメーター タイプ	オプション	説明
_filterFieldName	str	はい	フィルターを適用するフィールド名

戻り値

フィルターを適用するフィールド名

メソッド filterFieldValueList

フィルター処理動作に基づくフィルターの一覧フィールド値の取得

public List filterFieldValueList ()

戻り値

フィルター処理動作に基づくフィルターの一覧フィールド値

メソッド operator

結果のフェッチに使用される演算子

public str operator ([str _operator])

パラメーター

パラメーター名	パラメーター タイプ	オプション	説明
_operator	str	はい	結果のフェッチに使用される演算子

戻り値

結果のフェッチに使用される演算子

メソッド addFilterFieldValue

フィルター フィールド値の追加

public void addFilterFieldValue ( _filterFieldValueList)

パラメーター

パラメーター名	パラメーター タイプ	オプション	説明
_filterFieldValueList		False	フィルター処理動作に基づくフィルター フィールド値

クラス SysAppLookUpAttribute

ルックアップ ページでもあるページの修飾に使用される SysAppPageAttribute

メソッド

メソッド名	返品	説明
新規	無効	SysAppLookUpAttribute クラスの新しいインスタンスを作成する
displayFieldName	str	ルックアップ コントロールの表示フィールド名を取得します。
valueFieldName	str	ルックアップ コントロールのフィールド名の値の取得

メソッド new

SysAppLookUpAttribute クラスの新しいインスタンスを作成する

public void new (str _displayFieldName, str _valueFieldName)

パラメーター

パラメーター名	パラメーター タイプ	オプション	説明
_displayFieldName	str	False	ルックアップ表示フィールド。 ルックアップ ページの任意のコントロールの名前
_valueFieldName	str	False	ルックアップの値フィールド。 ルックアップ ページを構築しているルート データ コントラクトによって形成されたコントロールの名前

メソッド displayFieldName

ルックアップ コントロールの表示フィールド名を取得します。

public str displayFieldName ()

戻り値

ルックアップ コントロールの表示フィールド名

メソッド valueFieldName

ルックアップ コントロールのフィールド名の値の取得

public str valueFieldName ()

戻り値

ルックアップ コントロールのフィールド名値

クラス SysAppLookupFieldAttribute

アクションのフィールドのルックアップの修飾に使用される SysAppLookupFieldAttribute

メソッド

メソッド名	返品	説明
新規	無効	SysAppLookupFieldAttribute クラスの新しいインスタンスを作成する
entityName	str	ルックアップ ページが関連するエンティティの名前の取得

メソッド new

SysAppLookupFieldAttribute クラスの新しいインスタンスを作成する

public void new ( _name)

パラメーター

パラメーター名	パラメーター タイプ	オプション	説明
_name		False	ルックアップ ページが関連するエンティティの名前

メソッド entityName

ルックアップ ページが関連するエンティティの名前の取得

public str entityName ()

戻り値

エンティティの名前

クラス SysAppPageAttribute

ワークスペースのページを定義するメソッドの修飾に使用される SysAppPageAttribute

メソッド

メソッド名	返品	説明
新規	無効	SysAppPageAttribute クラスの新しいインスタンスを作成する
pageTitle	str	ページのページのタイトルの取得
pageDescription	str	ページの説明の取得

メソッド new

SysAppPageAttribute クラスの新しいインスタンスを作成する

public void new ([str _pageTitle], [str _pageDescription])

パラメーター

パラメーター名	パラメーター タイプ	オプション	説明
_pageTitle	str	はい	ページ タイトル
_pageDescription	str	はい	ページの説明

メソッド pageTitle

ページのページのタイトルの取得

public str pageTitle ()

戻り値

ページ タイトル

メソッド pageDescription

ページの説明の取得

public str pageDescription ()

戻り値

ページの説明

クラス SysAppPageMetadata

このクラスを使用すると、AX モバイル ワークスペースのページ メタデータにアクセスして更新できます。

方法

メソッド名	返品	説明
新規	無効
getPageName	str	ページ名を返します
pageTitle	str	ページ タイトルの取得および設定
pageDescription	str	ページの説明の取得または設定
pageHidden	ブール値	ワークスペースでページを表示にするかどうかの取得および設定
pageOrder	int	ページ順序の取得または設定
getControl	SysAppControlMetadata	指定されたコントロールの名前を持つ現在のページのコントロールを返します
getControlEnumerator	MapEnumerator	ページ コントロールを列挙するために使用できるマップ列挙子を返します。 ここで、Key はコントロール名で、値は SysAppControlMetadata 型です

メソッド new

public void new (Microsoft.Dynamics.Client.ServerForm.App.PageMetadata _pageMetadata)

パラメーター

パラメーター名	パラメーター タイプ	オプション	説明
_pageMetadata	Microsoft.Dynamics.Client.ServerForm.App.PageMetadata	False

メソッド getPageName

ページ名を返します

public str getPageName ()

戻り値

ページ名

メソッド pageTitle

ページ タイトルの取得および設定

public str pageTitle ([str _pageTitle])

パラメーター

パラメーター名	パラメーター タイプ	オプション	説明
_pageTitle	str	はい	ページ タイトル

戻り値

ページ タイトル

メソッド pageDescription

ページの説明の取得または設定

public str pageDescription ([str _pageDescription])

パラメーター

パラメーター名	パラメーター タイプ	オプション	説明
_pageDescription	str	真	ページの説明

戻り値

ページの説明>

メソッド pageHidden

ワークスペースでページを表示にするかどうかの取得および設定

public boolean pageHidden ([boolean _pageHidden])

パラメーター

パラメーター名	パラメーター タイプ	オプション	説明
_pageHidden	ブール値	はい	ページの非表示の値

戻り値

ワークスペースに現在のページが表示されない場合は true。それ以外の場合 false。

メソッド pageOrder

ページ順序の取得または設定

public int pageOrder ([int _pageOrder])

パラメーター

パラメーター名	パラメーター タイプ	オプション	説明
_pageOrder	int	はい	ページの順序

戻り値

ページの順序

メソッド getControl

指定されたコントロールの名前を持つ現在のページのコントロールを返します

public SysAppControlMetadata getControl (str _controlName)

パラメーター

パラメーター名	パラメーター タイプ	オプション	説明
_controlName	str	False	コントロールを検索するために使用されるコントロール名

戻り値

指定されたコントロール名を持つコントロールがページに存在する場合、SysAppControlMetadata のオブジェクトは返されます。それ以外の場合は null

メソッド getControlEnumerator

ページ コントロールを列挙するために使用できるマップ列挙子を返します。 ここで、Key はコントロール名で、値は SysAppControlMetadata 型です

public MapEnumerator getControlEnumerator ()

戻り値

マップ列挙子

クラス SysAppProjectionAttribute

非連結フィールドを形成するメソッドの修飾に使用される SysAppProjectionAttribute

メソッド

メソッド名	返品	説明
新規	無効	SysAppControlMetadataAttributes クラスの新しいインスタンスを作成する

メソッド new

SysAppControlMetadataAttributes クラスの新しいインスタンスを作成する

public void new (str _label)

パラメーター

パラメーター名	パラメーター タイプ	オプション	説明
_label	str	False	コントロール ラベル

クラス SysAppRelationalAttribute

参照コントロールの修飾に使用される SysAppRelationalAttribute

メソッド

メソッド名	返品	説明
新規	無効	コンストラクター

メソッド new

コンストラクター

public void new ([str _name])

パラメーター

パラメーター名	パラメーター タイプ	オプション	説明
_name	str	はい	参照されるエンティティのプロパティ名

クラス SysAppRequestParams

詳細とアクション ページを生成するための X++ メソッドのクラスをリクエスト

メソッド

メソッド名	返品	説明
entityContext	SysAppEntityContext	要求のエンティティ コンテキスト
filterContext	リスト	フィルター コンテキストの SysAppFilterContext のリスト

メソッド entityContext

要求のエンティティ コンテキスト

public SysAppEntityContext entityContext ([SysAppEntityContext _entityContext])

パラメーター

パラメーター名	パラメーター タイプ	オプション	説明
_entityContext	SysAppEntityContext	はい	要求のエンティティ コンテキスト

戻り値

要求のエンティティ コンテキスト

メソッド filterContext

フィルター コンテキストの SysAppFilterContext のリスト

public List filterContext ([List _filterContext])

パラメーター

パラメーター名	パラメーター タイプ	オプション	説明
_filterContext	リスト	はい	ページのフィルター コンテキストの SysAppFilterContext のリスト

戻り値

ページのフィルター コンテキストの SysAppFilterContext のリスト

クラス SysAppResponse

SysAppResponse クラス。 このクラスは、生成されたページおよびアクションのレスポンス オブジェクトを保持します。

メソッド

メソッド名	返品	説明
新規	無効
jobId	str	要求のジョブ ID
データ	Microsoft.Dynamics.Client.ServerForm.App.CompositeData	ページのデータ
failedInAppCall	ブール値	ページのデータ
commits	一覧	タスクが完了した後にコミットします。
メッセージ	一覧	要求のジョブ ID
addMessage	無効	メッセージの追加
addCommit	無効	コミットの追加

メソッド new

public void new ()

メソッド jobId

要求のジョブ ID

public str jobId ()

戻り値

要求のジョブ ID

メソッド data

ページのデータ

public Microsoft.Dynamics.Client.ServerForm.App.CompositeData data ([Microsoft.Dynamics.Client.ServerForm.App.CompositeData _data])

パラメーター

パラメーター名	パラメーター タイプ	オプション	説明
_data	Microsoft.Dynamics.Client.ServerForm.App.CompositeData	はい	ページのデータ

戻り値

ページのデータ

メソッド failedInAppCall

ページのデータ

public boolean failedInAppCall ([boolean _failedInAppCall])

パラメーター

パラメーター名	パラメーター タイプ	オプション	説明
_failedInAppCall	ブール値	はい	アプリケーション コードの呼び出しに失敗した場合は true に設定します。

戻り値

アプリケーション コードの呼び出しに失敗した場合は true です。

メソッド commits

タスクが完了した後にコミットします。

public List commits ()

戻り値

タスクが完了した後にコミットします。

メソッド messages

要求のジョブ ID

public List messages ()

戻り値

タスクが完了した後のメッセージ

メソッド addMessage

メッセージの追加

public void addMessage (SysAppResponseMessage _message)

パラメーター

パラメーター名	パラメーター タイプ	オプション	説明
_message	SysAppResponseMessage	False	SysAppResponseMessage オブジェクトとしてのメッセージ

メソッド addCommit

コミットの追加

public void addCommit (SysAppEntityContext _entityContext)

パラメーター

パラメーター名	パラメーター タイプ	オプション	説明
_entityContext	SysAppEntityContext	False	確定済エンティティのエンティティ名とエンティティ ID を含むエンティティ コンテキスト

クラス SysAppResponseMessage

応答メッセージの SysAppResponseMessage クラス

メソッド

メソッド名	返品	説明
新規	無効	SysAppResponseMessage クラスの新しいインスタンスを作成する
テキスト	str	メッセージ テキストの取得
タイプ	SysAppMessageType	メッセージ タイプを取得します: 情報、エラー、警告

メソッド new

SysAppResponseMessage クラスの新しいインスタンスを作成する

public void new (str _text, [SysAppMessageType _type])

パラメーター

パラメーター名	パラメーター タイプ	オプション	説明
_text	str	False	メッセージ テキスト
_type	SysAppMessageType	はい	メッセージ タイプ: 情報、エラー、警告

メソッド text

メッセージ テキストの取得

public str text ()

戻り値

メッセージ テキスト

メソッドのタイプ

メッセージ タイプを取得します: 情報、エラー、警告

public SysAppMessageType type ()

戻り値

メッセージ タイプ: 情報、エラー、警告

クラス SysAppSecurityAttribute

ページおよびアクションを形成するメソッドの修飾に使用される SysAppSecurityAttribute。 ページまたはアクションのセキュリティ属性を指定します

メソッド

メソッド名	返品	説明
新規	無効	SysAppSecurityAttribute クラスの新しいインスタンスを作成します。 これは、ログインしたユーザーが指定されたメニュー項目とメニュー項目の種類にアクセスできるかどうかを確認するのに役立ちます
menuItemType	MenuItemType	ページのメニュー項目タイプの取得
menuItemName	MenuItemName	ページのメニュー項目名の取得

メソッド new

SysAppSecurityAttribute クラスの新しいインスタンスを作成します。 これは、ログインしたユーザーが指定されたメニュー項目とメニュー項目の種類にアクセスできるかどうかを確認するのに役立ちます

public void new ([MenuItemName _menuItemName], [MenuItemType _menuItemType])

パラメーター

パラメーター名	パラメーター タイプ	オプション	説明
_menuItemName	MenuItemName	はい	ページのメニュー項目名
_menuItemType	MenuItemType	True	アクション、表示、または出力など、ページのメニュー項目タイプ

メソッド menuItemType

ページのメニュー項目タイプの取得

public MenuItemType menuItemType ()

戻り値

ページのメニュー項目タイプ

メソッド menuItemName

ページのメニュー項目名の取得

public MenuItemName menuItemName ()

戻り値

ページのメニュー項目名

クラス SysAppWorkspace

これは、 モバイル ワークスペースの基本クラスです。 モバイル ワークスペース クラスは、このクラスから拡張する必要があります

メソッド

メソッド名	返品	説明
getEnumValues	リスト	ワークスペースの初期化中に呼び出されます。 AX モバイルに返される列挙型の値を変更するために使用できます
getWorkspaceMetadata	SysAppWorkspaceMetadata	ワークスペースの初期化中に呼び出されます。 ワークスペースのメタデータを変更するために使用できます
onBeginAppJob	無効	AX モバイル ジョブの実行開始前の呼び出し
onEndAppJob	無効	AX モバイル ジョブの実行の終了後の呼び出し
workspaceHidden	ブール値	ワークスペースを非表示にするかどうかを制御するために使用できます。 現在のユーザーに、ワークスペース クラスの SysAppWorkspaceSecurityAttribute で指定されたアクセス メニュー項目があることを確認します。 クラスに属性が指定されていない場合は常に false を返します

メソッド getEnumValues

ワークスペースの初期化中に呼び出されます。 AX モバイルに返される列挙型の値を変更するために使用できます

public List getEnumValues (EnumName _enumName)

パラメーター

パラメーター名	パラメーター タイプ	オプション	説明
_enumName	EnumName	False	列挙名

戻り値

列挙値の一覧

メソッド getWorkspaceMetadata

ワークスペースの初期化中に呼び出されます。 ワークスペースのメタデータを変更するために使用できます

public SysAppWorkspaceMetadata getWorkspaceMetadata ()

戻り値

ワークスペース メタデータを表すオブジェクト

メソッド onBeginAppJob

AX モバイル ジョブの実行開始前の呼び出し

public void onBeginAppJob (SysAppJobRequest _sysAppJobRequest)

パラメーター

パラメーター名	パラメーター タイプ	オプション	説明
_sysAppJobRequest	SysAppJobRequest	False	ジョブ要求パラメーターを含むクラス

メソッド onEndAppJob

AX モバイル ジョブの実行の終了後の呼び出し

public void onEndAppJob (SysAppJobResponse _sysAppJobResponse)

パラメーター

パラメーター名	パラメーター タイプ	オプション	説明
_sysAppJobResponse	SysAppJobResponse	False	ジョブ応答パラメーターを含むクラス

メソッド workspaceHidden

ワークスペースを非表示にするかどうかを制御するために使用できます。 現在のユーザーに、ワークスペース クラスの SysAppWorkspaceSecurityAttribute で指定されたアクセス メニュー項目があることを確認します。 クラスに属性が指定されていない場合は常に false を返します

public boolean workspaceHidden ()

戻り値

ワークスペースが非表示の場合は true を返します。それ以外の場合は、false を返します

クラス SysAppWorkspaceAttribute

SysAppWorkspace から拡張されたクラスに適用されます。

メソッド

メソッド名	返品	説明
新規	無効	SysAppWorkspaceAttribute クラスの新しいインスタンスを作成する
AppId	str	ワークスペースの AppId の取得または設定
AppResourceName	str	ワークスペースを含む AOT リソース名の取得または設定
WorkspaceHidden	ブール型	ワークスペースがデザイナーに非表示かどうかを取得または設定

メソッド new

SysAppWorkspaceAttribute クラスの新しいインスタンスを作成する

public void new (str _appId, [str _appResourceName], [boolean _workspaceHidden])

パラメーター

パラメーター名	パラメーター タイプ	オプション	説明
_appId	str	False	ワークスペースの appId
_appResourceName	str	True	ワークスペースを含む AOT リソース名
_workspaceHidden	ブール型	True	ワークスペースはデザイナーには表示されません

メソッド AppId

ワークスペースの AppId の取得または設定

public str AppId ([str _appId])

パラメーター

パラメーター名	パラメーター タイプ	オプション	説明
_appId	str	はい	ワークスペースの AppId

戻り値

ワークスペースの AppId

メソッド AppResourceName

ワークスペースを含む AOT リソース名の取得または設定

public str AppResourceName ([str _appResourceName])

パラメーター

パラメーター名	パラメーター タイプ	オプション	説明
_appResourceName	str	True	ワークスペースを含む AOT リソース名

戻り値

ワークスペースを含む AOT リソース名

メソッド WorkspaceHidden

ワークスペースがデザイナーに非表示かどうかを取得または設定

public boolean WorkspaceHidden ([boolean _workspaceHidden])

パラメーター

パラメーター名	パラメーター タイプ	オプション	説明
_workspaceHidden	ブール値	はい	非表示のワークスペース

戻り値

ワークスペースがデザイナーに非表示かどうか

クラス SysAppWorkspaceMetadata

このクラスを使用すると、AX モバイル ワーク スペースのアクション メタデータにアクセスして更新できます。

方法

メソッド名	返品	説明
新規	無効
addConfig	無効	モバイル ワークスペース メタデータにカスタム構成を追加します。
getPage	SysAppPageMetadata	提供される pageName を持つページを返します
getPageEnumerator	MapEnumerator	ワークスペース ページを列挙するために使用できるマップ列挙子を返します。 ここで、key はページ名で、値は SysAppPageMetadata 型です
getAction	SysAppActionMetadata	提供される actionName を持つアクションを返します
getActionEnumerator	MapEnumerator	ワークスペース アクションを列挙するために使用できるマップ列挙子を返します。 ここで、key はアクション名で、値は SysAppActionMetadata 型です
getPageNameForRecordingId	str	指定された recordingId がワークスペース ページによって使用されている場合、pageName を返します
getActionNameForRecordingId	str	指定された recordingId がワークスペース アクションによって使用されている場合、actionName を返します
workspaceTitle	str	ワークスペース タイトルの取得および設定
workspaceDescription	str	ワークスペースの説明の取得および設定

メソッド new

public void new (str _appId, [SysAppWorkspaceAttribute _attribute])

パラメーター

パラメーター名	パラメーター タイプ	オプション	説明
_appId	str	False
_attribute	SysAppWorkspaceAttribute	はい

メソッド addConfig

モバイル ワークスペース メタデータにカスタム構成を追加します。

public void addConfig (str _configName, object _configValue)

パラメーター

パラメーター名	パラメーター タイプ	オプション	説明
_configName	str	False	コンフィギュレーション名
_configValue	オブジェクト	False	X++ データ契約クラスのオブジェクト

メソッド getPage

提供される pageName を持つページを返します

public SysAppPageMetadata getPage (str _pageName)

パラメーター

パラメーター名	パラメーター タイプ	オプション	説明
_pageName	str	False	ページ名

戻り値

指定した名前を持つページが存在する場合は pageMetadata を返します。それ以外の場合は null を返します

メソッド getPageEnumerator

ワークスペース ページを列挙するために使用できるマップ列挙子を返します。 ここで、key はページ名で、値は SysAppPageMetadata 型です

public MapEnumerator getPageEnumerator ()

戻り値

マップ列挙子

メソッド getAction

提供される actionName を持つアクションを返します

public SysAppActionMetadata getAction (str _actionName)

パラメーター

パラメーター名	パラメーター タイプ	オプション	説明
_actionName	str	False	アクション名

戻り値

指定した名前を持つアクションが存在する場合は ActionMetadata を返します。それ以外の場合は null を返します

メソッド getActionEnumerator

ワークスペース アクションを列挙するために使用できるマップ列挙子を返します。 ここで、key はアクション名で、値は SysAppActionMetadata 型です

public MapEnumerator getActionEnumerator ()

戻り値

マップ列挙子

メソッド getPageNameForRecordingId

指定された recordingId がワークスペース ページによって使用されている場合、pageName を返します

public str getPageNameForRecordingId (str _recordingId)

パラメーター

パラメーター名	パラメーター タイプ	オプション	説明
_recordingId	str	False	recordingId

戻り値

指定された recordingId をワークスペース ページで使用している場合のページ名です。それ以外は空の文字列です。

メソッド getActionNameForRecordingId

指定された recordingId がワークスペース アクションによって使用されている場合、actionName を返します

public str getActionNameForRecordingId (str _recordingId)

パラメーター

パラメーター名	パラメーター タイプ	オプション	説明
_recordingId	str	False	recordingId

戻り値

指定された recordingId をワークスペース アクションで使用している場合のアクション名です。それ以外は空の文字列です

メソッド workspaceTitle

ワークスペース タイトルの取得および設定

public str workspaceTitle ([str _workspaceTitle])

パラメーター

パラメーター名	パラメーター タイプ	オプション	説明
_workspaceTitle	str	はい	ワークスペースのタイトル

戻り値

ワークスペースのタイトル

メソッド workspaceDescription

ワークスペースの説明の取得および設定

public str workspaceDescription ([str _workspaceDescription])

パラメーター

パラメーター名	パラメーター タイプ	オプション	説明
_workspaceDescription	str	はい	ワークスペースの説明

戻り値

ワークスペースの説明

クラス SysAppWorkspaceSecurityAttribute

この属性に関連付けられたメニュー項目に基づいて、ワークスペースに基づく表示をコントロールします。

メソッド

メソッド名	返品	説明
新規	無効	属性の新しいインスタンスの作成
WorkspaceMenuItemName	MenuItemName	ワークスペース セキュリティ属性のワークスペース menuItem の取得または設定
WorkspaceMenuItemType	MenuItemType	ワークスペース セキュリティ属性のワークスペース メニュー項目タイプの取得または設定

メソッド new

属性の新しいインスタンスの作成

public void new (MenuItemName _workspaceMenuItemName, [MenuItemType _workspaceMenuItemType])

パラメーター

パラメーター名	パラメーター タイプ	オプション	説明
_workspaceMenuItemName	MenuItemName	False	ワークスペースを関連付ける必要のあるメニュー項目名
_workspaceMenuItemType	MenuItemType	はい	メニュー項目タイプ

メソッド WorkspaceMenuItemName

ワークスペース セキュリティ属性のワークスペース menuItem の取得または設定

public MenuItemName WorkspaceMenuItemName ([MenuItemName _workspaceMenuItemName])

パラメーター

パラメーター名	パラメーター タイプ	オプション	説明
_workspaceMenuItemName	MenuItemName	はい	ワークスペース セキュリティ属性のワークスペース メニュー項目

戻り値

ワークスペース セキュリティ属性のワークスペース メニュー項目

メソッド WorkspaceMenuItemType

ワークスペース セキュリティ属性のワークスペース メニュー項目タイプの取得または設定

public MenuItemType WorkspaceMenuItemType ([MenuItemType _workspaceMenuItemType])

パラメーター

パラメーター名	パラメーター タイプ	オプション	説明
_workspaceMenuItemType	MenuItemType	True	workspacesecurity 属性のワークスペース メニュー項目タイプ

戻り値

ワークスペース セキュリティ属性のワークスペース メニュー項目タイプ