SwiftKit/data/documentation/swiftkit/standardlocalizationservice.json

{"seeAlsoSections":[{"title":"Localization","identifiers":["doc:\/\/SwiftKit\/documentation\/SwiftKit\/BundleTranslator","doc:\/\/SwiftKit\/documentation\/SwiftKit\/LocalizationNotification","doc:\/\/SwiftKit\/documentation\/SwiftKit\/LocalizationService","doc:\/\/SwiftKit\/documentation\/SwiftKit\/StandardTranslator","doc:\/\/SwiftKit\/documentation\/SwiftKit\/Translator"],"generated":true}],"schemaVersion":{"major":0,"minor":2,"patch":0},"metadata":{"fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"StandardLocalizationService"}],"title":"StandardLocalizationService","roleHeading":"Class","role":"symbol","symbolKind":"class","externalID":"s:8SwiftKit27StandardLocalizationServiceC","modules":[{"name":"SwiftKit"}],"navigatorTitle":[{"kind":"identifier","text":"StandardLocalizationService"}]},"abstract":[{"type":"text","text":"This service lets you change the locale of your app without"},{"type":"text","text":" "},{"type":"text","text":"having to restart the app for the change to be applied."}],"sections":[],"identifier":{"url":"doc:\/\/SwiftKit\/documentation\/SwiftKit\/StandardLocalizationService","interfaceLanguage":"swift"},"relationshipsSections":[{"identifiers":["doc:\/\/SwiftKit\/documentation\/SwiftKit\/LocalizationService","doc:\/\/SwiftKit\/documentation\/SwiftKit\/Translator"],"kind":"relationships","title":"Conforms To","type":"conformsTo"}],"hierarchy":{"paths":[["doc:\/\/SwiftKit\/documentation\/SwiftKit"]]},"topicSections":[{"title":"Initializers","identifiers":["doc:\/\/SwiftKit\/documentation\/SwiftKit\/StandardLocalizationService\/init(translator:bundle:notificationCenter:userDefaults:)"]},{"title":"Instance Methods","identifiers":["doc:\/\/SwiftKit\/documentation\/SwiftKit\/StandardLocalizationService\/setLocale(_:)","doc:\/\/SwiftKit\/documentation\/SwiftKit\/StandardLocalizationService\/translate(_:)"]},{"title":"Enumerations","identifiers":["doc:\/\/SwiftKit\/documentation\/SwiftKit\/StandardLocalizationService\/LocaleError"]}],"variants":[{"paths":["\/documentation\/swiftkit\/standardlocalizationservice"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"StandardLocalizationService"}],"languages":["swift"],"platforms":["iOS"]}]},{"kind":"content","content":[{"anchor":"overview","level":2,"type":"heading","text":"Overview"},{"type":"paragraph","inlineContent":[{"type":"text","text":"This service wraps a translator, which is uses to translate"},{"type":"text","text":" "},{"type":"text","text":"language keys. A "},{"type":"codeVoice","code":"StandardTranslator"},{"type":"text","text":" will be used at first,"},{"type":"text","text":" "},{"type":"text","text":"but as soon as you call "},{"type":"codeVoice","code":"setLocale"},{"type":"text","text":" the standard translator"},{"type":"text","text":" "},{"type":"text","text":"will replaced with a "},{"type":"codeVoice","code":"BundleTranslator"},{"type":"text","text":", that will used the"},{"type":"text","text":" "},{"type":"text","text":"bundle of the new locale."}]}]}],"references":{"doc://SwiftKit/documentation/SwiftKit/StandardLocalizationService/LocaleError":{"role":"symbol","title":"StandardLocalizationService.LocaleError","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"LocaleError"}],"abstract":[],"identifier":"doc:\/\/SwiftKit\/documentation\/SwiftKit\/StandardLocalizationService\/LocaleError","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"LocaleError"}],"url":"\/documentation\/swiftkit\/standardlocalizationservice\/localeerror"},"doc://SwiftKit/documentation/SwiftKit/LocalizationService":{"role":"symbol","title":"LocalizationService","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"LocalizationService"}],"abstract":[{"type":"text","text":"This protocol can be implemented any "},{"type":"reference","isActive":true,"identifier":"doc:\/\/SwiftKit\/documentation\/SwiftKit\/Translator"},{"type":"text","text":" that is"},{"type":"text","text":" "},{"type":"text","text":"also capable of changing the app’s current locale."}],"identifier":"doc:\/\/SwiftKit\/documentation\/SwiftKit\/LocalizationService","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"LocalizationService"}],"url":"\/documentation\/swiftkit\/localizationservice"},"doc://SwiftKit/documentation/SwiftKit/LocalizationNotification":{"role":"symbol","title":"LocalizationNotification","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"LocalizationNotification"}],"abstract":[{"type":"text","text":"This enum has localization-specific notifications."}],"identifier":"doc:\/\/SwiftKit\/documentation\/SwiftKit\/LocalizationNotification","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"LocalizationNotification"}],"url":"\/documentation\/swiftkit\/localizationnotification"},"doc://SwiftKit/documentation/SwiftKit/StandardTranslator":{"role":"symbol","title":"StandardTranslator","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"StandardTranslator"}],"abstract":[{"type":"text","text":"This standard "},{"type":"reference","isActive":true,"identifier":"doc:\/\/SwiftKit\/documentation\/SwiftKit\/Translator"},{"type":"text","text":" implementation translates keys"},{"type":"text","text":" "},{"type":"text","text":"using "},{"type":"codeVoice","code":"NSLocalizedString"},{"type":"text","text":"."}],"identifier":"doc:\/\/SwiftKit\/documentation\/SwiftKit\/StandardTranslator","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StandardTranslator"}],"url":"\/documentation\/swiftkit\/standardtranslator"},"doc://SwiftKit/documentation/SwiftKit/StandardLocalizationService/setLocale(_:)":{"role":"symbol","title":"setLocale(_:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"setLocale"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"Locale","preciseIdentifier":"s:10Foundation6LocaleV"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"abstract":[{"type":"text","text":"Change the service’s locale."}],"identifier":"doc:\/\/SwiftKit\/documentation\/SwiftKit\/StandardLocalizationService\/setLocale(_:)","kind":"symbol","type":"topic","url":"\/documentation\/swiftkit\/standardlocalizationservice\/setlocale(_:)"},"doc://SwiftKit/documentation/SwiftKit/StandardLocalizationService/init(translator:bundle:notificationCenter:userDefaults:)":{"role":"symbol","title":"init(translator:bundle:notificationCenter:userDefaults:)","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"translator"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Translator","preciseIdentifier":"s:8SwiftKit10TranslatorP"},{"kind":"text","text":", "},{"kind":"externalParam","text":"bundle"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bundle","preciseIdentifier":"c:objc(cs)NSBundle"},{"kind":"text","text":", "},{"kind":"externalParam","text":"notificationCenter"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"NotificationCenter","preciseIdentifier":"c:objc(cs)NSNotificationCenter"},{"kind":"text","text":", "},{"kind":"externalParam","text":"userDefaults"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"UserDefaults","preciseIdentifier":"c:objc(cs)NSUserDefaults"},{"kind":"text","text":")"}],"abstract":[],"identifier":"doc:\/\/SwiftKit\/documentation\/SwiftKit\/StandardLocalizationService\/init(translator:bundle:notificationCenter:userDefaults:)","kind":"symbol","type":"topic","url":"\/documentation\/swiftkit\/standardlocalizationservice\/init(translator:bundle:notificationcenter:userdefaults:)"},"doc://SwiftKit/documentation/SwiftKit":{"role":"collection","title":"SwiftKit","abstract":[{"type":"text","text":"SwiftKit adds extra functionality to the Swift framework, like extensions to native types, utilites, services etc."}],"identifier":"doc:\/\/SwiftKit\/documentation\/SwiftKit","kind":"symbol","type":"topic","url":"\/documentation\/swiftkit"},"doc://SwiftKit/documentation/SwiftKit/Translator":{"role":"symbol","title":"Translator","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Translator"}],"abstract":[{"type":"text","text":"This protocol can be implemented by any classes that can be"},{"type":"text","text":" "},{"type":"text","text":"used to translate a localized string synchronously."}],"identifier":"doc:\/\/SwiftKit\/documentation\/SwiftKit\/Translator","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"Translator"}],"url":"\/documentation\/swiftkit\/translator"},"doc://SwiftKit/documentation/SwiftKit/BundleTranslator":{"role":"symbol","title":"BundleTranslator","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"BundleTranslator"}],"abstract":[{"type":"text","text":"This "},{"type":"codeVoice","code":"Translator"},{"type":"text","text":" translates keys using a certain "},{"type":"codeVoice","code":"Bundle"},{"type":"text","text":"."}],"identifier":"doc:\/\/SwiftKit\/documentation\/SwiftKit\/BundleTranslator","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"BundleTranslator"}],"url":"\/documentation\/swiftkit\/bundletranslator"},"doc://SwiftKit/documentation/SwiftKit/StandardLocalizationService":{"role":"symbol","title":"StandardLocalizationService","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"StandardLocalizationService"}],"abstract":[{"type":"text","text":"This service lets you change the locale of your app without"},{"type":"text","text":" "},{"type":"text","text":"having to restart the app for the change to be applied."}],"identifier":"doc:\/\/SwiftKit\/documentation\/SwiftKit\/StandardLocalizationService","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StandardLocalizationService"}],"url":"\/documentation\/swiftkit\/standardlocalizationservice"},"doc://SwiftKit/documentation/SwiftKit/StandardLocalizationService/translate(_:)":{"role":"symbol","title":"translate(_:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"translate"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"abstract":[{"type":"text","text":"Translate the provided key to a localized string."}],"identifier":"doc:\/\/SwiftKit\/documentation\/SwiftKit\/StandardLocalizationService\/translate(_:)","kind":"symbol","type":"topic","url":"\/documentation\/swiftkit\/standardlocalizationservice\/translate(_:)"}}}