ProductNameFormat
ProductNameFormat APIには、製品名の置き換えを使用して文字列をフォーマットするメソッドが用意されています。フォーマット文字列リソース内では製品名プレースホルダーとして、引数パターン$(pn)を使用できます。
複数の製品名タイプをフォーマットメソッドと組み合わせて使用できます。以下は、さまざまなタイプのAmazon Echo Show 5製品名の例です。
| タイプ | 名前 |
|---|---|
| Generic | Device |
| Short | Echo Show |
| Medium | Echo Show 5 |
| Long | Echo Show 5（第3世代） |
| Full | Amazon Echo Show 5 |
| Generational | Amazon Echo Show 5（第3世代） |
Defaultタイプも用意されており、これはMediumタイプに相当します。
コンストラクタ
new ProductNameFormat()
new ProductNameFormat(): ProductNameFormat
戻り値
メソッド
format()
staticformat(pattern:string, productNameType?: ProductNameType, args?:Map<string, string | number | Date> | undefined):string | null
デフォルトロケールでの製品名の置き換えを使用して、指定されたパターンをフォーマットします。オプションで、パターンは、名前付き引数を持つMessageFormatClassicパターンにすることもできます。パターンは、製品名のプレースホルダーとして、1つ以上の「$(pn)」部分文字列を含む必要があります。
また、このメソッドは、商品名の性に基づいてメッセージ選択を行う「pngender」をサポートしています。これを使用するには、IMessageFormatClassicのフォーマット選択引数の代わりに「pngender」を指定し、取り得る性別（other（その他）、feminine（女性名詞）、masculine（男性名詞）、neuter（中性名詞）、female（女性名）、male（男性名））に基づいてフォーマット選択句を記述します。下記の例を参照してください。
パラメーター
pattern
string
フォーマット対象のパターン。
productNameType?
使用する製品名のタイプ。
args?
Map<string, string | number | Date> | undefined
引数名からその値へのマップ（任意）。成功した場合は、「$(pn)」の代わりに、指定された製品名に置き換えられてフォーマットされたメッセージが返されます。失敗した場合はnullになります。
戻り値
string | null
例
{pngender, select,
feminine {$(pn) displays a notification on her screen.}
masculine {$(pn) displays a notification on his screen.}
other {$(pn) displays a notification on its screen.}}
現在の製品の性がfeminineで、製品名が「Echo Show」の場合、このメソッドは「Echo Show displays a notification on her screen.」を返します。
[重要]「pngender」という名前は、ProductNameFormatによって予約されているキーであるため、名前付き引数として使用しないでください。引数マップに「pngender」という名前付き引数が渡された場合、このメソッドは失敗します。
formatPositional()
staticformatPositional(pattern:string, productNameType?: ProductNameType, args?:(string | number | Date)[]):string | null
デフォルトロケールでの製品名の置き換えを使用して、指定されたパターンをフォーマットします。オプションで、パターンは、番号付き引数を持つMessageFormatClassicパターンにすることもできます。パターンは、製品名のプレースホルダーとして、1つ以上の「$(pn)」部分文字列を含む必要があります。
製品名の性に基づくメッセージを選択するための「pngender」サポートについては、format()メソッドを参照してください。
パラメーター
pattern
string
フォーマット対象のパターン。
productNameType?
使用する製品名のタイプ。
args?
(string | number | Date)[]
引数の値で構成される任意の配列：成功した場合は、「$(pn)」が指定された製品名に置き換えられてフォーマットされたメッセージが返されます。失敗した場合はnullになります。
戻り値
string | null
getMajorVersion()
staticgetMajorVersion():number
メジャーバージョン番号を取得します。メジャーバージョン番号。
戻り値
number
getMinorVersion()
staticgetMinorVersion():number
マイナーバージョン番号を取得します。マイナーバージョン番号。
戻り値
number
getPatchVersion()
staticgetPatchVersion():number
パッチバージョン番号を取得します。パッチバージョン番号。
戻り値
number
Last updated: 2026年7月22日
