Show mobile map package expiration date

View on GitHub

Access the expiration information of an expired mobile map package.

Image of Show mobile map package expiration date

Use case

The data contained within a mobile map package (MMPK) may only be relevant for a fixed period of time. Using ArcGIS Pro, the author of an MMPK can set an expiration date to ensure the user is aware the data is out of date.

As long as the author of an MMPK has set an expiration date, the expiration date can be read even if the MMPK has not yet expired. For example, developers could also use this API to warn app users that an MMPK may be expiring soon.

How to use the sample

Load the app. The author of the MMPK used in this sample chose to set the MMPK's map as still readable, even if it's expired. The app presents expiration information to the user.

How it works

Create a MobileMapPackage object by passing in the URL to the mobile map package's location.
Load the mobile map package.
Present the mobile map package's expiration information to the user:

Use Expiration.message to get the expiration message set by the author of the MMPK.
Use Expiration.date to get the expiration date set by the author of the MMPK.

Relevant API

Expiration
MobileMapPackage

Offline data

This sample uses the LothianRiversAnno - Expired mobile map package. It is downloaded from ArcGIS Online automatically.

Sample Code

ShowMobileMapPackageExpirationDateView.swift
Use dark colors for code blocksCopy
// Copyright 2023 Esri
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//   https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

import ArcGIS
import SwiftUI

struct ShowMobileMapPackageExpirationDateView: View {
    /// A map with no specified style.
    @State private var map = Map()

    /// The mobile map package created from a URL to a local mobile map package file.
    @State private var mapPackage = MobileMapPackage(fileURL: .lothianRiversAnno)

    /// The error shown in the error alert.
    @State private var error: Error?

    var body: some View {
        ZStack {
            MapView(map: map)
                .task {
                    do {
                        // Set the map to the first map in the mobile map package.
                        try await mapPackage.load()
                        if let map = mapPackage.maps.first {
                            self.map = map
                        }
                    } catch {
                        self.error = error
                    }
                }

            // Display the expiration message and date if the map package is expired.
            if let expiration = mapPackage.expiration, expiration.isExpired {
                VStack {
                    Text(expiration.message)
                    Text("Expiration date: \(expiration.date?.formatted() ?? "N/A")")
                        .padding(.top)
                }
                .multilineTextAlignment(.center)
                .padding()
                .background(.thinMaterial)
            }
        }
        .errorAlert(presentingError: $error)
    }
}

private extension URL {
    /// The URL to the local Lothian Rivers Anno mobile map package file.
    static var lothianRiversAnno: URL {
        Bundle.main.url(forResource: "LothianRiversAnno", withExtension: "mmpk")!
    }
}