ProductNameFormat
ProductNameFormat APIには、製品名の置き換えを使用して文字列をフォーマットするメソッドが用意されています。フォーマット文字列リソース内では製品名プレースホルダーとして、引数パターン$(pn)を使用できます。
複数の製品名タイプをフォーマットメソッドと組み合わせて使用できます。以下は、さまざまなタイプのAmazon Echo Show 5製品名の例です。
| タイプ | 名前 |
|---|---|
| Generic | デバイス |
| Short | Echo Show |
| Medium | Echo Show 5 |
| 長整数 | Echo Show 5（第3世代） |
| Full | Amazon Echo Show 5 |
| Generational | Amazon Echo Show 5（第3世代） |
Defaultタイプも用意されており、これはMediumタイプにマッピングします。
例
import { ProductNameFormat, ProductNameType } from '@amazon-devices/keplerscript-kepleri18n-lib';
...
// パターンは文字列リソースから取得してください。ここでは例を簡単にするためにハードコードしています。
const pattern: string = "この$(pn)はWi-Fiに対応しています。";
const message: string | null = ProductNameFormat.format(pattern, ProductNameType.MEDIUM);
if (message === null) {
// エラー
return;
}
// 上のAmazon Echo Show 5の製品名の例では、messageは「このEcho Show 5はWi-Fiに対応しています。」となります。
コンストラクタ
new ProductNameFormat()
new ProductNameFormat():
ProductNameFormat
戻り値
メソッド
format()
staticformat(pattern,productNameType,args?):null|string
デフォルトロケールでの製品名の置き換えを使用して、指定されたパターンをフォーマットします。オプションで、パターンは、名前付き引数を持つMessageFormatClassicパターンにすることもできます。パターンは、製品名のプレースホルダーとして、1つ以上の「$(pn)」部分文字列を含む必要があります。
また、このメソッドは、商品名の性に基づいてメッセージ選択を行う「pngender」をサポートしています。これを使用するには、IMessageFormatClassicのフォーマット選択引数の代わりに「pngender」を指定し、取り得る性別（other（その他）、feminine（女性名詞）、masculine（男性名詞）、neuter（中性名詞）、female（女性名）、male（男性名））に基づいてフォーマット選択句を記述します。下記の例を参照してください。
パラメーター
pattern
string
フォーマット対象のパターン。
productNameType
ProductNameType = ProductNameType.DEFAULT
使用する製品名のタイプ。
args?
Map<string, string | number | Date>
引数名からその値へのマップ（オプション）。
戻り値
null | string
成功した場合は、「$(pn)」の代わりに、指定された製品名に置き換えられてフォーマットされたメッセージが返されます。失敗した場合は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,productNameType, …args):null|string
デフォルトロケールでの製品名の置き換えを使用して、指定されたパターンをフォーマットします。オプションで、パターンは、番号付き引数を持つMessageFormatClassicパターンにすることもできます。パターンは、製品名のプレースホルダーとして、1つ以上の「$(pn)」部分文字列を含む必要があります。
製品名の性に基づくメッセージを選択するための「pngender」サポートについては、format()メソッドを参照してください。
パラメーター
pattern
string
フォーマット対象のパターン。
productNameType
ProductNameType = ProductNameType.DEFAULT
使用する製品名のタイプ。
args
…(string | number | Date)[]
引数値の配列（オプション）。
戻り値
null | string
成功した場合は、「$(pn)」の代わりに、指定された製品名に置き換えられてフォーマットされたメッセージが返されます。失敗した場合はnullになります。
getMajorVersion()
staticgetMajorVersion():number
メジャーバージョン番号を取得します。
戻り値
number
メジャーバージョン番号。
getMinorVersion()
staticgetMinorVersion():number
マイナーバージョン番号を取得します。
戻り値
number
マイナーバージョン番号。
getPatchVersion()
staticgetPatchVersion():number
パッチバージョン番号を取得します。
戻り値
number
パッチバージョン番号。
Last updated: 2025年9月29日
